PHP Class Contao\FormCheckBox

Inheritance: extends Widget

Protected Properties

Method	Description
__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

Method	Description
getOptions ( ) : array	Generate the options

Return a parameter

public __get ( string $strKey ) : mixed
$strKey	string	The parameter key
return	mixed	The parameter value

Add specific attributes

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

Generate the widget and return it as string

public generate ( ) : string
return	string	The widget markup

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
return	string	The form field markup

Return all attributes as string

public getAttributes ( array $arrStrip = [] ) : string
$arrStrip	array	An optional array with attributes to strip
return	string	The attributes string

Generate the options

protected getOptions ( ) : array
return	array	The options array

Check the options if the field is mandatory

public validate ( )

Submit user input

protected bool $blnSubmitInput
return	boolean

Error message

protected string $strError
return	string

The CSS class prefix

protected string $strPrefix
return	string

Template

protected string $strTemplate
return	string