Element Base Class

Zend\Form\Element is a base class for all specialized elements and Zend\Form\Fieldset.

Basic Usage

At the bare minimum, each element or fieldset requires a name. You will also typically provide some attributes to hint to the view layer how it might render the item.

use Zend\Form\Element;
use Zend\Form\Form;

$username = new Element\Text('username');
$username
    ->setLabel('Username')
    ->setAttributes(array(
        'class' => 'username',
        'size'  => '30',
    ));

$password = new Element\Password('password');
$password
    ->setLabel('Password')
    ->setAttributes(array(
        'size'  => '30',
    ));

$form = new Form('my-form');
$form
    ->add($username)
    ->add($password);

Public Methods

setName(string $name)

Set the name for this element.

getName()

Return the name for this element.

Return type:string

setValue(string $value)

Set the value for this element.

getValue()

Return the value for this element.

Return type:string

setLabel(string $label)

Set the label content for this element.

getLabel()

Return the label content for this element.

Return type:string

setLabelAttributes(array $labelAttributes)

Set the attributes to use with the label.

getLabelAttributes()

Return the attributes to use with the label.

Return type:array

setLabelOptions(array $labelOptions)

Set label specific options.

getLabelOptions()

Return the label specific options.

Return type:array

setOptions(array $options)

Set options for an element. Accepted options are: label, label_attributes", label_options, which call setLabel, setLabelAttributes and setLabelOptions, respectively.

getOptions()

Get defined options for an element

Return type:array

getOption(string $option)

Return the specified option, if defined. If it’s not defined, returns null.

Return type:null|mixed

setAttribute(string $key, mixed $value)

Set a single element attribute.

getAttribute(string $key)

Retrieve a single element attribute.

Return type:mixed

removeAttribute(string $key)

Remove a single attribute

hasAttribute(string $key)

Check if a specific attribute exists for this element.

Return type:boolean

setAttributes(array|Traversable $arrayOrTraversable)

Set many attributes at once. Implementation will decide if this will overwrite or merge.

getAttributes()

Retrieve all attributes at once.

Return type:array|Traversable

removeAttributes(array $keys)

Remove many attributes at once

clearAttributes()

Clear all attributes for this element.

setMessages(array|Traversable $messages)

Set a list of messages to report when validation fails.

getMessages()

Returns a list of validation failure messages, if any.

Return type:array|Traversable