Fully Qualified Name: | Laminas\Form\Element\DateSelect |
Extends: | MonthSelect |
Name | Description | Defined By |
---|---|---|
__clone() | Clone the element (this is needed by Collection element, as it needs different copies of the elements) | DateSelect |
__construct() | Constructor. Add the day select element | DateSelect |
clearAttributes() | Clear all attributes | Element |
clearLabelOptions() | Clear all label options | Element |
getAttribute() | Retrieve a single element attribute | Element |
getAttributes() | Retrieve all attributes at once | Element |
getDayAttributes() | Get the day attributes | DateSelect |
getDayElement() | DateSelect | |
getElements() | Get both the year and month elements | DateSelect |
getInputSpecification() | Should return an array specification compatible with {@link Laminas\InputFilter\Factory::createInput()}. | DateSelect |
getLabel() | Retrieve the label used for this element | Element |
getLabelAttributes() | Get the attributes to use with the label | Element |
getLabelOption() | Retrieve a single label option | Element |
getLabelOptions() | Get label specific options | Element |
getMaxYear() | MonthSelect | |
getMessages() | Get validation error messages, if any. | Element |
getMinYear() | MonthSelect | |
getMonthAttributes() | Get the month attributes | MonthSelect |
getMonthElement() | MonthSelect | |
getName() | Get value for name | Element |
getOption() | Return the specified option | Element |
getOptions() | Get defined options | Element |
getValue() | DateSelect | |
getYearAttributes() | Get the year attributes | MonthSelect |
getYearElement() | MonthSelect | |
hasAttribute() | Does the element has a specific attribute ? | Element |
hasLabelOption() | Does the element has a specific label option ? | Element |
init() | This function is automatically called when creating element with factory. It allows to perform various operations (add elements. | Element |
prepareElement() | Prepare the form element (mostly used for rendering purposes) | DateSelect |
removeAttribute() | Remove a single attribute | Element |
removeAttributes() | Remove many attributes at once | Element |
removeLabelOption() | Remove a single label option | Element |
removeLabelOptions() | Remove many attributes at once | Element |
setAttribute() | Set a single element attribute | Element |
setAttributes() | Set many attributes at once | Element |
setDayAttributes() | Set the day attributes | DateSelect |
setLabel() | Set the label used for this element | Element |
setLabelAttributes() | Set the attributes to use with the label | Element |
setLabelOption() | Set a single label optionn | Element |
setLabelOptions() | Set many label options at once | Element |
setMaxYear() | MonthSelect | |
setMessages() | Set a list of messages to report when validation fails | Element |
setMinYear() | MonthSelect | |
setMonthAttributes() | Set the month attributes | MonthSelect |
setName() | Set value for name | Element |
setOption() | Set a single option for an element | Element |
setOptions() | Accepted options for DateSelect (plus the ones from MonthSelect) : - day_attributes: HTML attributes to be rendered with the day element | DateSelect |
setShouldCreateEmptyOption() | MonthSelect | |
setShouldRenderDelimiters() | MonthSelect | |
setValue() | DateSelect | |
setYearAttributes() | Set the year attributes | MonthSelect |
shouldCreateEmptyOption() | MonthSelect | |
shouldRenderDelimiters() | MonthSelect |
Clone the element (this is needed by Collection element, as it needs different copies of the elements)
Returns:
Constructor. Add the day select element
Parameter Name | Type | Description |
---|---|---|
$name | null|int|string | Optional |
$options | array | Optional |
Returns:
Clear all attributes
Returns: $this
Clear all label options
Returns: $this
Retrieve a single element attribute
Parameter Name | Type | Description |
---|---|---|
$key | ||
$key |
Returns: mixed|null
Retrieve all attributes at once
Returns: array|\Traversable
Get the day attributes
Returns: array
Returns: \Select
Get both the year and month elements
Returns: array
Should return an array specification compatible with {@link Laminas\InputFilter\Factory::createInput()}.
Returns: array
Retrieve the label used for this element
Returns: null|string
Get the attributes to use with the label
Returns: array
Retrieve a single label option
Parameter Name | Type | Description |
---|---|---|
$key | ||
$key |
Returns: mixed|null
Get label specific options
Returns: array
Returns: int
Get validation error messages, if any.
Returns a list of validation failure messages, if any.
Returns: array|\Traversable
Returns: int
Get the month attributes
Returns: array
Returns: \Select
Get value for name
Returns: string|int
Return the specified option
Parameter Name | Type | Description |
---|---|---|
$option | string |
Returns: null|mixed
Get defined options
Returns: array
Returns: string
Get the year attributes
Returns: array
Returns: \Select
Does the element has a specific attribute ?
Parameter Name | Type | Description |
---|---|---|
$key | string |
Returns: bool
Does the element has a specific label option ?
Parameter Name | Type | Description |
---|---|---|
$key | string |
Returns: bool
This function is automatically called when creating element with factory. It allows to perform various operations (add elements.
..)
Returns: void
Prepare the form element (mostly used for rendering purposes)
Parameter Name | Type | Description |
---|---|---|
$form | \FormInterface |
Returns: mixed
Remove a single attribute
Parameter Name | Type | Description |
---|---|---|
$key | string |
Returns: $this
Remove many attributes at once
Parameter Name | Type | Description |
---|---|---|
$keys | array |
Returns: $this
Remove a single label option
Parameter Name | Type | Description |
---|---|---|
$key | string |
Returns: $this
Remove many attributes at once
Parameter Name | Type | Description |
---|---|---|
$keys | array |
Returns: $this
Set a single element attribute
Parameter Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Returns: $this
Set many attributes at once
Implementation will decide if this will overwrite or merge.
Parameter Name | Type | Description |
---|---|---|
$arrayOrTraversable | array|\Traversable |
Returns: $this
Set the day attributes
Parameter Name | Type | Description |
---|---|---|
$dayAttributes | array |
Returns: $this
Set the label used for this element
Parameter Name | Type | Description |
---|---|---|
$label | ||
$label |
Returns: $this
Set the attributes to use with the label
Parameter Name | Type | Description |
---|---|---|
$labelAttributes | array |
Returns: $this
Set a single label optionn
Parameter Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Returns: $this
Set many label options at once
Implementation will decide if this will overwrite or merge.
Parameter Name | Type | Description |
---|---|---|
$arrayOrTraversable | array|\Traversable |
Returns: $this
Parameter Name | Type | Description |
---|---|---|
$maxYear | int |
Returns: $this
Set a list of messages to report when validation fails
Parameter Name | Type | Description |
---|---|---|
$messages | array|\Traversable |
Returns: $this
Parameter Name | Type | Description |
---|---|---|
$minYear | int |
Returns: $this
Set the month attributes
Parameter Name | Type | Description |
---|---|---|
$monthAttributes | array |
Returns: $this
Set value for name
Parameter Name | Type | Description |
---|---|---|
$name | string |
Returns: $this
Set a single option for an element
Parameter Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Returns: $this
Accepted options for DateSelect (plus the ones from MonthSelect) : - day_attributes: HTML attributes to be rendered with the day element
Parameter Name | Type | Description |
---|---|---|
$options | array|\Traversable |
Returns: $this
Parameter Name | Type | Description |
---|---|---|
$createEmptyOption | bool |
Returns: $this
Parameter Name | Type | Description |
---|---|---|
$renderDelimiters | bool |
Returns: $this
Parameter Name | Type | Description |
---|---|---|
$value | string|array|\ArrayAccess|\PhpDateTime |
Returns: $this Provides a fluent interface
Set the year attributes
Parameter Name | Type | Description |
---|---|---|
$yearAttributes | array |
Returns: $this
Returns: bool
Returns: bool