IPB/system/Helpers/Form/CheckboxSet.php

<?php
/**
 * @brief		Checkbox Set class for Form Builder
 * @author		<a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
 * @copyright	(c) Invision Power Services, Inc.
 * @license		https://www.invisioncommunity.com/legal/standards/
 * @package		Invision Community
 * @since		19 Jul 2013
 */

namespace IPS\Helpers\Form;

/* To prevent PHP errors (extending class does not exist) revealing path */

use IPS\Member;
use IPS\Request;
use IPS\Theme;
use function count;
use function defined;
use function is_array;

if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
	header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
	exit;
}

/**
 * Checkbox Set class for Form Builder
 */
class CheckboxSet extends Select
{
	/**
	 * Constructor
	 *
	 * @param string $name Name
	 * @param mixed $defaultValue Default value
	 * @param bool|null $required Required? (NULL for not required, but appears to be so)
	 * @param array $options Type-specific options
	 * @param callable|null $customValidationCode Custom validation code
	 * @param string|null $prefix HTML to show before input field
	 * @param string|null $suffix HTML to show after input field
	 * @param string|null $id The ID to add to the row
	 */
	public function __construct( string $name, mixed $defaultValue=NULL, ?bool $required=FALSE, array $options=array(), callable $customValidationCode=NULL, string $prefix=NULL, string $suffix=NULL, string $id=NULL )
	{
		$options['multiple'] = TRUE;
		$options['showAllNone'] = $options['showAllNone'] ?? TRUE;
		$options['condense'] = $options['condense'] ?? TRUE;
		parent::__construct( $name, $defaultValue, $required, $options, $customValidationCode, $prefix, $suffix, $id );

		if ( !isset( $this->options['descriptions'] ) )
		{
			$this->options['descriptions'] = array();
		}
	}
	
	/** 
	 * Get HTML
	 *
	 * @return	string
	 */
	public function html(): string
	{
		/* Get descriptions */
		$descriptions = $this->options['descriptions'];
		if ( $this->options['parse'] === 'lang' )
		{
			foreach ( $this->options['options'] as $k => $v )
			{
				$key = "{$v}_desc";
				if ( Member::loggedIn()->language()->checkKeyExists( $key ) )
				{
					$descriptions[ $k ] = Member::loggedIn()->language()->addToStack( $key );
				}
			}
		}
		
		/* Translate labels back to keys? */
		if ( $this->options['returnLabels'] )
		{
			$value = array();
			if ( !is_array( $this->value ) )
			{
				$this->value = explode( ',', $this->value );
			}
			foreach ( $this->value as $v )
			{
				$value[] = array_search( $v, $this->options['options'] );
			}
		}
		else
		{
			$value = $this->value;
		}

		/* If the value is NULL or an empty string, i.e. from a custom field, then we should not convert it into an array because the
			value will evaluate to 0 with an == check and the first option in the checkbox set will always be selected erroneously */
		if ( $this->options['unlimited'] === NULL and !is_array( $value ) AND $value !== NULL AND $value !== '' )
		{
			$value = array( $value );
		}
		
		return Theme::i()->getTemplate( 'forms', 'core', 'global' )->checkboxset( $this->name, $value, $this->required, $this->parseOptions(), $this->options['multiple'], $this->options['class'], $this->options['disabled'], $this->options['toggles'], NULL, $this->options['unlimited'], $this->options['unlimitedLang'], $this->options['unlimitedToggles'], $this->options['unlimitedToggleOn'], $descriptions, $this->options['impliedUnlimited'], $this->options['showAllNone'], $this->options['condense'], $this->options['userSuppliedInput'] );
	}
	
	/**
	 * Get value
	 *
	 * @return	array
	 */
	public function getValue(): mixed
	{
		$value = parent::getValue();

		if ( $this->options['unlimited'] !== NULL and $value === $this->options['unlimited'] )
		{
			return $value;
		}
		
		/* We need the array keys.  For custom fields we will have 0 => 1, 1 => 1 if checkboxes 0 and 1 are checked, while for Content we will have
			customKey => 1, customOtherKey => 1 - we always need the array keys */
		$value = is_array( $value ) ? array_keys( $value ) : array();

		if ( $this->options['unlimited'] !== NULL and $this->options['impliedUnlimited'] and count( $value ) == count( $this->options['options'] ) )
		{
			return $this->options['unlimited'];
		}

		$return = array();
		if ( $this->options['returnLabels'] )
		{
			if ( is_array( $value ) )
			{
				foreach ( $value as $k => $v )
				{
					$return[ $k ] = $this->options['options'][ $v ];
				}
			}
			else
			{
				$return[] = $this->options['options'][ $value ];
			}
		}
		else
		{
			$return = $value;
		}

		/* User-supplied input */
		if( isset( $this->options['userSuppliedInput'] ) AND $this->options['userSuppliedInput'] AND in_array( $this->options['userSuppliedInput'], $value ) )
		{
			$otherTextField = $this->options['userSuppliedInput'] . '_' . $this->name;
			$index = array_search( $this->options['userSuppliedInput'], $return );
			if( $index !== false )
			{
				unset( $return[ $index ] );
			}

			$return[] = Request::i()->$otherTextField;
		}

		return $return;
	}
}