| package |
Default |
| inherited_from |
\Zend\Form\Element\DateTime |
Methods
__construct()
__construct(null|integer|string $name = null, array $options = array())
Inherited
Parameters
$name
nullintegerstringOptional name for the element
$options
arrayOptional options for the element
Exceptions
\Zend\Form\Exception\InvalidArgumentException |
|
Clear all attributes
clearAttributes() : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
| inherited_from |
\Zend\Form\ElementAttributeRemovalInterface::clearAttributes() |
Returns
\Zend\Form\Element\Zend\Form\ElementInterface
Clear all label options
clearLabelOptions() : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
| inherited_from |
\Zend\Form\LabelAwareInterface::clearLabelOptions() |
Returns
\Zend\Form\Element\Zend\Form\ElementInterface
Retrieve a single element attribute
getAttribute(string $key) : mixed | null
Inherited
| inherited_from |
\Zend\Form\ElementInterface::getAttribute() |
Parameters
$key
Returns
mixednull
Retrieve all attributes at once
getAttributes() : array | \Traversable
Inherited
| inherited_from |
\Zend\Form\ElementInterface::getAttributes() |
Returns
array\Traversable
Retrieve the label used for this element
getLabel() : null | string
Inherited
| inherited_from |
\Zend\Form\ElementInterface::getLabel() |
Returns
nullstring
Get the attributes to use with the label
getLabelAttributes() : array
Inherited
| inherited_from |
\Zend\Form\LabelAwareInterface::getLabelAttributes() |
Returns
array
Retrieve a single label option
getLabelOption($key) : mixed | null
Inherited
| inherited_from |
\Zend\Form\LabelAwareInterface::getLabelOption() |
Parameters
$key
Returns
mixednull
Get label specific options
getLabelOptions() : array
Inherited
| inherited_from |
\Zend\Form\LabelAwareInterface::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\ElementInterface::getMessages() |
Returns
array\Traversable
Get value for name
getName() : string | integer
Inherited
| inherited_from |
\Zend\Form\ElementInterface::getName() |
Returns
stringinteger
Return the specified option
getOption(string $option) : NULL | mixed
Inherited
| inherited_from |
\Zend\Form\ElementInterface::getOption() |
Parameters
$option
string
Returns
NULLmixed
Get defined options
getOptions() : array
Inherited
| inherited_from |
\Zend\Form\ElementInterface::getOptions() |
Returns
array
Retrieve the element value
getValue() : mixed
Inherited
| inherited_from |
\Zend\Form\ElementInterface::getValue() |
Returns
mixed
Does the element has a specific attribute ?
hasAttribute(string $key) : boolean
Inherited
| inherited_from |
\Zend\Form\ElementInterface::hasAttribute() |
Parameters
$key
string
Returns
boolean
Does the element has a specific label option ?
hasLabelOption(string $key) : boolean
Inherited
| inherited_from |
\Zend\Form\LabelAwareInterface::hasLabelOption() |
Parameters
$key
string
Returns
boolean
This function is automatically called when creating element with factory. It
allows to perform various operations (add elements.
init() : void
Inherited
| inherited_from |
\Zend\Stdlib\InitializableInterface::init() |
Remove a single attribute
removeAttribute(string $key) : \Zend\Form\ElementInterface
Inherited
| inherited_from |
\Zend\Form\ElementAttributeRemovalInterface::removeAttribute() |
Parameters
$key
string
Returns
\Zend\Form\ElementInterface
Remove many attributes at once
removeAttributes(array $keys) : \Zend\Form\ElementInterface
Inherited
| inherited_from |
\Zend\Form\ElementAttributeRemovalInterface::removeAttributes() |
Parameters
$keys
array
Returns
\Zend\Form\ElementInterface
Remove a single label option
removeLabelOption(string $key) : \Zend\Form\ElementInterface
Inherited
| inherited_from |
\Zend\Form\LabelAwareInterface::removeLabelOption() |
Parameters
$key
string
Returns
\Zend\Form\ElementInterface
Remove many attributes at once
removeLabelOptions(array $keys) : \Zend\Form\ElementInterface
Inherited
| inherited_from |
\Zend\Form\LabelAwareInterface::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\ElementInterface::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\ElementInterface::setAttributes() |
Parameters
$arrayOrTraversable
array\Traversable
Exceptions
\Zend\Form\Exception\InvalidArgumentException |
|
Returns
\Zend\Form\Element\Zend\Form\ElementInterface
Set the label used for this element
setLabel($label) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
| inherited_from |
\Zend\Form\ElementInterface::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\LabelAwareInterface::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\LabelAwareInterface::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\LabelAwareInterface::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\ElementInterface::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\ElementInterface::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\Element\Month
Inherited
| inherited_from |
\Zend\Form\ElementInterface::setOption() |
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$key
string
$value
mixed
Returns
\Zend\Form\Element\Month
Set options for an element. 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
setOptions(array|\Traversable $options) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
| inherited_from |
\Zend\Form\ElementInterface::setOptions() |
Parameters
$options
array\Traversable
Exceptions
\Zend\Form\Exception\InvalidArgumentException |
|
Returns
\Zend\Form\Element\Zend\Form\ElementInterface
Set the element value
setValue(mixed $value) : \Zend\Form\Element
Inherited
| inherited_from |
\Zend\Form\ElementInterface::setValue() |
Parameters
$value
mixed
Returns
\Zend\Form\Element
Retrieves a Date Validator configured for a Month Input type
getDateValidator() : \Zend\Validator\ValidatorInterface
| inherited_from |
\Zend\Form\Element\DateTime::getDateValidator() |
Returns
\Zend\Validator\ValidatorInterface
Retrieves a Date Validator configured for a DateTime Input type
getDateValidator() : \Zend\Form\Element\DateTime
Inherited
Returns
\Zend\Form\Element\DateTime
Retrieves a DateStep Validator configured for a Month Input type
getStepValidator() : \Zend\Validator\ValidatorInterface
| inherited_from |
\Zend\Form\Element\DateTime::getStepValidator() |
Returns
\Zend\Validator\ValidatorInterface
Retrieves a DateStep Validator configured for a DateTime Input type
getStepValidator() : \Zend\Form\Element\DateTime
Inherited
Returns
\Zend\Form\Element\DateTime
Get validators
getValidators() : array
Inherited
Properties
Seed attributes
$attributes : array
Default
array('type' => 'month')
| inherited_from |
\Zend\Form\Element\DateTime::attributes |
$attributes
$attributes : array
$label
$label : null | string
$labelAttributes
$labelAttributes : array
Label specific options
$labelOptions : array
Validation error messages
$messages : array
custom options
$options : array
$validators
$validators : array
Constants