103 lines
2.3 KiB
PHP
103 lines
2.3 KiB
PHP
<?php
|
|
/**
|
|
* @brief Checkbox 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 26 Feb 2013
|
|
*/
|
|
|
|
namespace IPS\Helpers\Form;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
|
|
use IPS\Request;
|
|
use IPS\Theme;
|
|
use function defined;
|
|
use function intval;
|
|
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Checkbox class for Form Builder
|
|
*/
|
|
class Checkbox extends FormAbstract
|
|
{
|
|
/**
|
|
* @brief Default Options
|
|
* @code
|
|
$defaultOptions = array(
|
|
'disabled' => FALSE, // Disabled?
|
|
'togglesOn' => array( ... ), // IDs of elements to show when checked
|
|
'togglesOff' => array( ... ), // IDs of elements to show when unchecked
|
|
'label' => '', // Label language key
|
|
);
|
|
* @endcode
|
|
*/
|
|
protected array $defaultOptions = array(
|
|
'disabled' => FALSE,
|
|
'togglesOn' => array(),
|
|
'togglesOff' => array(),
|
|
'label' => '',
|
|
);
|
|
|
|
/**
|
|
* Get HTML
|
|
*
|
|
* @return string
|
|
*/
|
|
public function html(): string
|
|
{
|
|
if ( !$this->htmlId )
|
|
{
|
|
$this->htmlId = md5( 'ips_checkbox_' . $this->name );
|
|
}
|
|
|
|
$checkboxName = preg_replace( '/^(.+?\[?.+?)(\])?$/', '$1_checkbox$2', $this->name );
|
|
return Theme::i()->getTemplate( 'forms', 'core', 'global' )->checkbox( $checkboxName, $this->value, $this->options['disabled'], $this->options['togglesOn'], $this->options['togglesOff'], $this->options['label'], $this->name, $this->htmlId );
|
|
}
|
|
|
|
/**
|
|
* Format Value
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function formatValue(): bool
|
|
{
|
|
return (bool) $this->value;
|
|
}
|
|
|
|
/**
|
|
* Get Value
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getValue(): mixed
|
|
{
|
|
$checkboxName = preg_replace( '/^(.+?\[?.+?)(\])?$/', '$1_checkbox$2', $this->name );
|
|
if ( mb_strpos( $checkboxName, '[' ) === FALSE )
|
|
{
|
|
return Request::i()->$checkboxName;
|
|
}
|
|
else
|
|
{
|
|
return Request::i()->valueFromArray( $checkboxName );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* String Value
|
|
*
|
|
* @param mixed $value The value
|
|
* @return string|int|null
|
|
*/
|
|
public static function stringValue( mixed $value ): string|int|null
|
|
{
|
|
return intval( $value );
|
|
}
|
|
} |