PHP Класс Contao\FormCheckBox

Наследование: extends Widget
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$blnSubmitInput boolean Submit user input
$strError string Error message
$strPrefix string The CSS class prefix
$strTemplate string Template

Открытые методы

Метод Описание
__get ( string $strKey ) : mixed Return a parameter
__set ( string $strKey, mixed $varValue ) Add specific attributes
generate ( ) : string Generate the widget and return it as string
generateWithError ( boolean $blnSwitchOrder = false ) : string Override the parent method and inject the error message inside the fieldset (see #3392)
getAttributes ( array $arrStrip = [] ) : string Return all attributes as string
validate ( ) Check the options if the field is mandatory

Защищенные методы

Метод Описание
getOptions ( ) : array Generate the options

Описание методов

__get() публичный Метод

Return a parameter
public __get ( string $strKey ) : mixed
$strKey string The parameter key
Результат mixed The parameter value

__set() публичный Метод

Add specific attributes
public __set ( string $strKey, mixed $varValue )
$strKey string The attribute name
$varValue mixed The attribute value

generate() публичный Метод

Generate the widget and return it as string
public generate ( ) : string
Результат string The widget markup

generateWithError() публичный Метод

Override the parent method and inject the error message inside the fieldset (see #3392)
public generateWithError ( boolean $blnSwitchOrder = false ) : string
$blnSwitchOrder boolean If true, the error message will be shown below the field
Результат string The form field markup

getAttributes() публичный Метод

Return all attributes as string
public getAttributes ( array $arrStrip = [] ) : string
$arrStrip array An optional array with attributes to strip
Результат string The attributes string

getOptions() защищенный Метод

Generate the options
protected getOptions ( ) : array
Результат array The options array

validate() публичный Метод

Check the options if the field is mandatory
public validate ( )

Описание свойств

$blnSubmitInput защищенное свойство

Submit user input
protected bool $blnSubmitInput
Результат boolean

$strError защищенное свойство

Error message
protected string $strError
Результат string

$strPrefix защищенное свойство

The CSS class prefix
protected string $strPrefix
Результат string

$strTemplate защищенное свойство

Template
protected string $strTemplate
Результат string