• Inicio
• Contao
• Widget

PHP Class Contao\Widget

The class functions as abstract parent class for all widget classes and provides methods to generate the form field markup and to validate the form field input. Usage: $widget = new TextField(); $widget->name = 'test'; $widget->label = 'Test'; if ($_POST) { $widget->validate(); if (!$widget->hasErrors()) { echo $widget->value; } } Mostrar archivo Open project: contao/core-bundle Class Usage Examples

Protected Properties

Property	Type	Description
$arrAttributes	array	Attributes
$arrConfiguration	array	Configuration
$arrErrors	array	Errors
$arrOptions	array	Options
$blnForAttribute	boolean	For attribute indicator
$blnSubmitInput	boolean	Submit indicator
$objDca	object	Data container
$strClass	string	CSS class
$strId	integer	Id
$strLabel	string	Label
$strName	string	Name
$strPrefix	string	CSS class prefix
$strWizard	string	Wizard
$varValue	mixed	Value

Public Methods

Method	Description
__construct ( array $arrAttributes = null )	Initialize the object
__get ( string $strKey ) : string	Return an object property
__isset ( string $strKey ) : boolean	Check whether an object property exists
__set ( string $strKey, mixed $varValue )	Set an object property
addAttribute ( string $strName, mixed $varValue )	Add an attribute
addAttributes ( array $arrAttributes )	Take an associative array and add it to the object's attributes
addError ( string $strError )	Add an error message
generate ( ) : string	Generate the widget and return it as string
generateLabel ( ) : string	Generate the label and return it as string
generateWithError ( boolean $blnSwitchOrder = false ) : string	Generate the widget with error message and return it as string
getAttribute ( string $strKey ) : string	Return a single attribute
getAttributes ( array $arrStrip = [] ) : string	Return all attributes as string
getAttributesFromDca ( array $arrData, string $strName, mixed $varValue = null, string $strField = '', string $strTable = '', DataContainer | null $objDca = null ) : array	Extract the Widget attributes from a Data Container array
getEmptyStringOrNull ( ) : string | integer | null	Return either an empty string or null based on the SQL string
getEmptyStringOrNullByFieldType ( string $sql ) : string | null	Return either an empty string or null based on the SQL string
getEmptyValue ( ) : string | integer | null	Return the empty value based on the SQL string
getEmptyValueByFieldType ( string $sql ) : string | integer | null	Return the empty value based on the SQL string
getErrorAsHTML ( integer $intIndex ) : string	Return a particular error as HTML string
getErrorAsString ( integer $intIndex ) : string	Return a particular error as string
getErrors ( ) : array	Return the errors array
getErrorsAsString ( string $strSeparator = null ) : string	Return all errors as string separated by a given separator
hasErrors ( ) : boolean	Return true if the widget has errors
optionChecked ( string $strOption, mixed $varValues ) : string	Return a "checked" attribute if the option is checked
optionSelected ( string $strOption, mixed $varValues ) : string	Return a "selected" attribute if the option is selected
parse ( array $arrAttributes = null ) : string	Parse the template file and return it as string
submitInput ( ) : boolean	Return true if the widgets submits user input
validate ( )	Validate the user input and set the value

Protected Methods

Method	Description
addSubmit ( ) : string	Generate a submit button
getPost ( string $strKey ) : mixed	Find and return a $_POST variable
isChecked ( array $arrOption ) : string	Check whether an option is checked
isSelected ( array $arrOption ) : string	Check whether an option is selected
isValidOption ( mixed $varInput ) : boolean	Check whether an input is one of the given options
validator ( mixed $varInput ) : mixed	Recursively validate an input variable

Method Details

Property Details