Interface Phalcon\Forms\ElementInterface
Phalcon\Forms\ElementInterface initializer
Methods
abstract public Phalcon\Forms\ElementInterface setForm (Phalcon\Forms\Form $form)
Sets the parent form to the element
abstract public Phalcon\Forms\ElementInterface getForm ()
Returns the parent form to the element
abstract public Phalcon\Forms\ElementInterface setName (string $name)
Sets the element’s name
abstract public string getName ()
Returns the element’s name
abstract public Phalcon\Forms\ElementInterface setFilters (array|string $filters)
Sets the element’s filters
abstract public Phalcon\Forms\ElementInterface addFilter (string $filter)
Adds a filter to current list of filters
abstract public mixed getFilters ()
Returns the element’s filters
abstract public Phalcon\Forms\ElementInterface addValidators (unknown $validators, [unknown $merge])
Adds a group of validators
abstract public Phalcon\Forms\ElementInterface addValidator (unknown $validator)
Adds a validator to the element
abstract public Phalcon\Validation\ValidatorInterface [] getValidators ()
Returns the validators registered for the element
abstract public array prepareAttributes ([array $attributes], [boolean $useChecked])
Returns an array of prepared attributes for Phalcon\Tag helpers according to the element’s parameters
abstract public Phalcon\Forms\ElementInterface setAttribute (string $attribute, mixed $value)
Sets a default attribute for the element
abstract public mixed getAttribute (string $attribute, [mixed $defaultValue])
Returns the value of an attribute if present
abstract public Phalcon\Forms\ElementInterface setAttributes (array $attributes)
Sets default attributes for the element
abstract public array getAttributes ()
Returns the default attributes for the element
abstract public Phalcon\Forms\ElementInterface setUserOption (string $option, mixed $value)
Sets an option for the element
abstract public mixed getUserOption (string $option, [mixed $defaultValue])
Returns the value of an option if present
abstract public Phalcon\Forms\ElementInterface setUserOptions (array $options)
Sets options for the element
abstract public array getUserOptions ()
Returns the options for the element
abstract public Phalcon\Forms\ElementInterface setLabel (string $label)
Sets the element label
abstract public string getLabel ()
Returns the element’s label
abstract public string label ()
Generate the HTML to label the element
abstract public Phalcon\Forms\ElementInterface setDefault (mixed $value)
Sets a default value in case the form does not use an entity or there is no value available for the element in $_POST
abstract public mixed getDefault ()
Returns the default value assigned to the element
abstract public mixed getValue ()
Returns the element’s value
abstract public Phalcon\Validation\Message\Group getMessages ()
Returns the messages that belongs to the element The element needs to be attached to a form
abstract public boolean hasMessages ()
Checks whether there are messages attached to the element
abstract public Phalcon\Forms\ElementInterface setMessages (Phalcon\Validation\Message\Group $group)
Sets the validation messages related to the element
abstract public Phalcon\Forms\ElementInterface appendMessage (Phalcon\Validation\Message $message)
Appends a message to the internal message list
abstract public Phalcon\Forms\Element clear ()
Clears every element in the form to its default value
abstract public string render ([array $attributes])
Renders the element widget
© 2011–2016 Phalcon Framework Team
Licensed under the Creative Commons Attribution License 3.0.
https://docs.phalconphp.com/en/2.0.0/api/Phalcon_Forms_ElementInterface.html