Zend Framework » \Zend\Form\Element\Csrf

Methods

__construct()

__construct(null | int | string $name, array $options)

Inherited

inherited_from	\Zend\Form\Element::__construct()

Parameters

$name

nullintstring

Optional name for the element

$options

array

Optional options for the element

Exceptions

`\Zend\Form\Exception\InvalidArgumentException`

Clear all attributes

clearAttributes() : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::clearAttributes()

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Clear all label options

clearLabelOptions() : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::clearLabelOptions()

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Retrieve a single element attribute

getAttribute($key) : mixed | null

Inherited

inherited_from	\Zend\Form\Element::getAttribute()

Parameters

$key

Returns

mixednull

Override: get attributes

getAttributes() : array

Seeds 'value' attribute with validator hash

Returns

array

Get CSRF validator

getCsrfValidator() : \Zend\Validator\Csrf

Returns

\Zend\Validator\Csrf

getCsrfValidatorOptions()

getCsrfValidatorOptions() : array

Returns

array

Provide default input rules for this element

getInputSpecification() : array

Attaches the captcha as a validator.

Returns

array

Retrieve the label used for this element

getLabel() : null | string

Inherited

inherited_from	\Zend\Form\Element::getLabel()

Returns

nullstring

Get the attributes to use with the label

getLabelAttributes() : array

Inherited

inherited_from	\Zend\Form\Element::getLabelAttributes()

Returns

array

Retrieve a single label option

getLabelOption($key) : mixed | null

Inherited

inherited_from	\Zend\Form\Element::getLabelOption()

Parameters

$key

Returns

mixednull

Get label specific options

getLabelOptions() : array

Inherited

inherited_from	\Zend\Form\Element::getLabelOptions()

Returns

array

Get validation error messages, if any.

getMessages() : array | \Traversable

Inherited

Returns a list of validation failure messages, if any.

inherited_from	\Zend\Form\Element::getMessages()

Returns

array\Traversable

Get value for name

getName() : string | int

Inherited

inherited_from	\Zend\Form\Element::getName()

Returns

stringint

Return the specified option

getOption(string $option) : NULL | mixed

Inherited

inherited_from	\Zend\Form\Element::getOption()

Parameters

$option

string

Returns

NULLmixed

Get defined options

getOptions() : array

Inherited

inherited_from	\Zend\Form\Element::getOptions()

Returns

array

Retrieve value

getValue() : string

Retrieves the hash from the validator

Returns

string

Does the element has a specific attribute ?

hasAttribute(string $key) : bool

Inherited

inherited_from	\Zend\Form\Element::hasAttribute()

Parameters

$key

string

Returns

bool

Does the element has a specific label option ?

hasLabelOption(string $key) : bool

Inherited

inherited_from	\Zend\Form\Element::hasLabelOption()

Parameters

$key

string

Returns

bool

This function is automatically called when creating element with factory.

init() : void

Inherited

It allows to perform various operations (add elements...)

inherited_from	\Zend\Form\Element::init()

Prepare the form element

prepareElement(\Zend\Form\FormInterface $form) : mixed

Parameters

$form

\Zend\Form\FormInterface

Returns

mixed

Remove a single attribute

removeAttribute(string $key) : \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::removeAttribute()

Parameters

$key

string

Returns

\Zend\Form\ElementInterface

Remove many attributes at once

removeAttributes(array $keys) : \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::removeAttributes()

Parameters

$keys

array

Returns

\Zend\Form\ElementInterface

Remove a single label option

removeLabelOption(string $key) : \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::removeLabelOption()

Parameters

$key

string

Returns

\Zend\Form\ElementInterface

Remove many attributes at once

removeLabelOptions(array $keys) : \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::removeLabelOptions()

Parameters

$keys

array

Returns

\Zend\Form\ElementInterface

Set a single element attribute

setAttribute(string $key, mixed $value) : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::setAttribute()

Parameters

$key

string

$value

mixed

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set many attributes at once

setAttributes(array | \Traversable $arrayOrTraversable) : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

Implementation will decide if this will overwrite or merge.

inherited_from	\Zend\Form\Element::setAttributes()

Parameters

$arrayOrTraversable

array\Traversable

Exceptions

`\Zend\Form\Exception\InvalidArgumentException`

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

setCsrfValidator()

setCsrfValidator(\Zend\Validator\Csrf $validator) : \Zend\Form\Element\Csrf

Parameters

$validator

\Zend\Validator\Csrf

Returns

\Zend\Form\Element\Csrf

setCsrfValidatorOptions()

setCsrfValidatorOptions(array $options) : \Zend\Form\Element\Csrf

Parameters

$options

array

Returns

\Zend\Form\Element\Csrf

Set the label used for this element

setLabel($label) : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::setLabel()

Parameters

$label

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set the attributes to use with the label

setLabelAttributes(array $labelAttributes) : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::setLabelAttributes()

Parameters

$labelAttributes

array

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set a single label optionn

setLabelOption(string $key, mixed $value) : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::setLabelOption()

Parameters

$key

string

$value

mixed

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set many label options at once

setLabelOptions(array | \Traversable $arrayOrTraversable) : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

Implementation will decide if this will overwrite or merge.

inherited_from	\Zend\Form\Element::setLabelOptions()

Parameters

$arrayOrTraversable

array\Traversable

Exceptions

`\Zend\Form\Exception\InvalidArgumentException`

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set a list of messages to report when validation fails

setMessages(array | \Traversable $messages) : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

inherited_from	\Zend\Form\Element::setMessages()

Parameters

$messages

array\Traversable

Exceptions

`\Zend\Form\Exception\InvalidArgumentException`

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set value for name

setName(string $name) : \Zend\Form\Element | \Zend\Form\ElementInterface

Inherited

In most cases, this will proxy to the attributes for storage, but is present to indicate that elements are generally named.

inherited_from	\Zend\Form\Element::setName()

Parameters

$name

string

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set a single option for an element

setOption(string $key, mixed $value) : \Zend\Form\self

Inherited

inherited_from	\Zend\Form\Element::setOption()

Parameters

$key

string

$value

mixed

Returns

\Zend\Form\self

Accepted options for Csrf: - csrf_options: an array used in the Csrf

setOptions(array | \Traversable $options) : \Zend\Form\Element\Csrf

Accepted options are: - label: label to associate with the element - label_attributes: attributes to use when the label is rendered - label_options: label specific options

Parameters

$options

array\Traversable

Exceptions

`\Zend\Form\Exception\InvalidArgumentException`

Returns

\Zend\Form\Element\Csrf

Set the element value

setValue(mixed $value) : \Zend\Form\Element

Inherited

inherited_from	\Zend\Form\Element::setValue()

Parameters

$value

mixed

Returns

\Zend\Form\Element

Properties

Seed attributes

$attributes : array

$csrfValidator

$csrfValidator : \Zend\Validator\Csrf

$csrfValidatorOptions

$csrfValidatorOptions : array

$label

$label : null | string

Inherited

inherited_from	\Zend\Form\Element::$$label

$labelAttributes

$labelAttributes : array

Inherited

inherited_from	\Zend\Form\Element::$$labelAttributes

Label specific options

$labelOptions : array

Inherited

inherited_from	\Zend\Form\Element::$$labelOptions

<p>Validation error messages</p>

$messages : array

Inherited

inherited_from	\Zend\Form\Element::$$messages

<p>custom options</p>

$options : array

Inherited

inherited_from	\Zend\Form\Element::$$options

$value

$value : mixed

Inherited

inherited_from	\Zend\Form\Element::$$value