Dojo/Form/Element/TimeTextBox.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Dojo
- Subpackage
- Form_Element
\Zend_Dojo_Form_Element_TimeTextBox
- Parent(s)
- \Zend_Dojo_Form_Element_DateTextBox < \Zend_Dojo_Form_Element_ValidationTextBox < \Zend_Dojo_Form_Element_TextBox < \Zend_Dojo_Form_Element_Dijit < \Zend_Form_Element
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
- \global\Zend_Dojo_Form_Element_DateTextBox
- Version
- $Id: TimeTextBox.php 24593 2012-01-05 20:35:02Z matthew $
Constants
DECORATOR
= 'DECORATOR'- Inherited_from
- \Zend_Form_Element::DECORATOR
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::DECORATOR
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::DECORATOR
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::DECORATOR
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::DECORATOR
FILTER
= 'FILTER'- Inherited_from
- \Zend_Form_Element::FILTER
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::FILTER
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::FILTER
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::FILTER
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::FILTER
VALIDATE
= 'VALIDATE'- Inherited_from
- \Zend_Form_Element::VALIDATE
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::VALIDATE
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::VALIDATE
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::VALIDATE
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::VALIDATE
Properties

bool $_allowEmpty = truetrueDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_allowEmpty
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_allowEmpty
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_allowEmpty
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_allowEmpty
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_allowEmpty

array $_allowedFormatTypes = array('long', 'short', 'medium', 'full')array('long', 'short', 'medium', 'full')Details- Type
- array
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_allowedFormatTypes

array $_allowedSelectorTypes = array('time', 'date')array('time', 'date')Details- Type
- array
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_allowedSelectorTypes

bool $_autoInsertNotEmptyValidator = truetrueDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_autoInsertNotEmptyValidator
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_autoInsertNotEmptyValidator
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_autoInsertNotEmptyValidator
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_autoInsertNotEmptyValidator
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_autoInsertNotEmptyValidator

string $_belongsTo- Type
- string
- Inherited_from
- \Zend_Form_Element::$$_belongsTo
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_belongsTo
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_belongsTo
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_belongsTo
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_belongsTo

array $_decorators = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_decorators
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_decorators
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_decorators
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_decorators
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_decorators

string $_description- Type
- string
- Inherited_from
- \Zend_Form_Element::$$_description
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_description
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_description
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_description
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_description

bool $_disableLoadDefaultDecorators = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_disableLoadDefaultDecorators
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_disableLoadDefaultDecorators
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_disableLoadDefaultDecorators
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_disableLoadDefaultDecorators
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_disableLoadDefaultDecorators

string $_errorMessageSeparator = '; ''; 'Details- Type
- string
- Inherited_from
- \Zend_Form_Element::$$_errorMessageSeparator
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_errorMessageSeparator
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_errorMessageSeparator
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_errorMessageSeparator
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_errorMessageSeparator

array $_errorMessages = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_errorMessages
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_errorMessages
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_errorMessages
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_errorMessages
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_errorMessages

array $_errors = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_errors
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_errors
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_errors
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_errors
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_errors

array $_filters = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_filters
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_filters
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_filters
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_filters
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_filters

bool $_ignore = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_ignore
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_ignore
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_ignore
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_ignore
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_ignore

bool $_isArray = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_isArray
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_isArray
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_isArray
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_isArray
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_isArray

bool $_isError = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_isError
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_isError
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_isError
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_isError
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_isError

bool $_isErrorForced = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_isErrorForced
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_isErrorForced
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_isErrorForced
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_isErrorForced
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_isErrorForced

bool $_isPartialRendering = falseThis is to allow execution of logic inside the render() methods of child elements during the magic call while skipping the parent render() method.
falseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_isPartialRendering
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_isPartialRendering
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_isPartialRendering
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_isPartialRendering
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_isPartialRendering

string $_label- Type
- string
- Inherited_from
- \Zend_Form_Element::$$_label
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_label
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_label
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_label
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_label

array $_loaders = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_loaders
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_loaders
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_loaders
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_loaders
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_loaders

array $_messages = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_messages
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_messages
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_messages
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_messages
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_messages

string $_name- Type
- string
- Inherited_from
- \Zend_Form_Element::$$_name
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_name
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_name
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_name
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_name

int $_order- Type
- int
- Inherited_from
- \Zend_Form_Element::$$_order
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_order
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_order
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_order
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_order

bool $_required = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_required
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_required
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_required
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_required
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_required

\Zend_Translate $_translator- Type
- \Zend_Translate
- Inherited_from
- \Zend_Form_Element::$$_translator
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_translator
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_translator
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_translator
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_translator

bool $_translatorDisabled = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_translatorDisabled
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_translatorDisabled
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_translatorDisabled
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_translatorDisabled
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_translatorDisabled

string $_type- Type
- string
- Inherited_from
- \Zend_Form_Element::$$_type
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_type
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_type
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_type
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_type

array $_validatorRules = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_validatorRules
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_validatorRules
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_validatorRules
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_validatorRules
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_validatorRules

array $_validators = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_validators
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_validators
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_validators
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_validators
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_validators

mixed $_value- Type
- mixed
- Inherited_from
- \Zend_Form_Element::$$_value
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_value
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_value
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_value
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_value

\Zend_View_Interface $_view- Type
- \Zend_View_Interface
- Inherited_from
- \Zend_Form_Element::$$_view
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$_view
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$_view
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$_view
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$_view

array $dijitParams = array()array()Details- Type
- array
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$dijitParams
- Inherited_from
- \Zend_Dojo_Form_Element_TextBox::$$dijitParams
- Inherited_from
- \Zend_Dojo_Form_Element_ValidationTextBox::$$dijitParams
- Inherited_from
- \Zend_Dojo_Form_Element_DateTextBox::$$dijitParams
Methods

__call(string $method, array $args) : stringOverloading: allow rendering specific decorators
Inherited from: \Zend_Form_Element::__call()\Zend_Dojo_Form_Element_Dijit::__call()\Zend_Dojo_Form_Element_TextBox::__call()\Zend_Dojo_Form_Element_ValidationTextBox::__call()\Zend_Dojo_Form_Element_DateTextBox::__call()Call renderDecoratorName() to render a specific decorator.
| Name | Type | Description |
|---|---|---|
| $method | string | |
| $args | array |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Form_Exception | for invalid decorator or invalid method call |

__construct(mixed $spec, mixed $options = null) : voidConstructor
Inherited from: \Zend_Dojo_Form_Element_Dijit::__construct()\Zend_Dojo_Form_Element_TextBox::__construct()\Zend_Dojo_Form_Element_ValidationTextBox::__construct()\Zend_Dojo_Form_Element_DateTextBox::__construct()$spec may be: - string: name of element - array: options with which to configure element - Zend_Config: Zend_Config with options for configuring element
| Name | Type | Description |
|---|---|---|
| $spec | mixed | |
| $options | mixed |
| Exception | Description |
|---|---|
| \Zend_Form_Exception | if no element name after initialization |

__get(string $key) : mixedOverloading: retrieve object property
Inherited from: \Zend_Form_Element::__get()\Zend_Dojo_Form_Element_Dijit::__get()\Zend_Dojo_Form_Element_TextBox::__get()\Zend_Dojo_Form_Element_ValidationTextBox::__get()\Zend_Dojo_Form_Element_DateTextBox::__get()Prevents access to properties beginning with '_'.
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |

__set(string $key, mixed $value) : \voideOverloading: set object property
Inherited from: \Zend_Form_Element::__set()\Zend_Dojo_Form_Element_Dijit::__set()\Zend_Dojo_Form_Element_TextBox::__set()\Zend_Dojo_Form_Element_ValidationTextBox::__set()\Zend_Dojo_Form_Element_DateTextBox::__set()| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \voide |

__toString() : stringString representation of form element
Inherited from: \Zend_Form_Element::__toString()\Zend_Dojo_Form_Element_Dijit::__toString()\Zend_Dojo_Form_Element_TextBox::__toString()\Zend_Dojo_Form_Element_ValidationTextBox::__toString()\Zend_Dojo_Form_Element_DateTextBox::__toString()Proxies to render().
| Type | Description |
|---|---|
| string |

_castBoolToString(mixed $item, string $key) : voidCast a boolean value to a string
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::_castBoolToString()\Zend_Dojo_Form_Element_DateTextBox::_castBoolToString()| Name | Type | Description |
|---|---|---|
| $item | mixed | |
| $key | string |

_filterValue(string $value, string $key) : voidFilter a value
Inherited from: \Zend_Form_Element::_filterValue()\Zend_Dojo_Form_Element_Dijit::_filterValue()\Zend_Dojo_Form_Element_TextBox::_filterValue()\Zend_Dojo_Form_Element_ValidationTextBox::_filterValue()\Zend_Dojo_Form_Element_DateTextBox::_filterValue()| Name | Type | Description |
|---|---|---|
| $value | string | |
| $key | string |

_getDecorator(string $name, null | array $options) : \Zend_Form_Decorator_InterfaceInstantiate a decorator based on class name or class name fragment
Inherited from: \Zend_Form_Element::_getDecorator()\Zend_Dojo_Form_Element_Dijit::_getDecorator()\Zend_Dojo_Form_Element_TextBox::_getDecorator()\Zend_Dojo_Form_Element_ValidationTextBox::_getDecorator()\Zend_Dojo_Form_Element_DateTextBox::_getDecorator()| Name | Type | Description |
|---|---|---|
| $name | string | |
| $options | null | array |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Interface |

_getErrorMessages() : arrayRetrieve error messages and perform translation and value substitution
Inherited from: \Zend_Form_Element::_getErrorMessages()\Zend_Dojo_Form_Element_Dijit::_getErrorMessages()\Zend_Dojo_Form_Element_TextBox::_getErrorMessages()\Zend_Dojo_Form_Element_ValidationTextBox::_getErrorMessages()\Zend_Dojo_Form_Element_DateTextBox::_getErrorMessages()| Type | Description |
|---|---|
| array |

_hasErrorMessages() : boolAre there custom error messages registered?
Inherited from: \Zend_Form_Element::_hasErrorMessages()\Zend_Dojo_Form_Element_Dijit::_hasErrorMessages()\Zend_Dojo_Form_Element_TextBox::_hasErrorMessages()\Zend_Dojo_Form_Element_ValidationTextBox::_hasErrorMessages()\Zend_Dojo_Form_Element_DateTextBox::_hasErrorMessages()| Type | Description |
|---|---|
| bool |

_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_InterfaceLazy-load a decorator
Inherited from: \Zend_Form_Element::_loadDecorator()\Zend_Dojo_Form_Element_Dijit::_loadDecorator()\Zend_Dojo_Form_Element_TextBox::_loadDecorator()\Zend_Dojo_Form_Element_ValidationTextBox::_loadDecorator()\Zend_Dojo_Form_Element_DateTextBox::_loadDecorator()| Name | Type | Description |
|---|---|---|
| $decorator | array | Decorator type and options |
| $name | mixed | Decorator name or alias |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Interface |

_loadFilter(array $filter) : \Zend_Filter_InterfaceLazy-load a filter
Inherited from: \Zend_Form_Element::_loadFilter()\Zend_Dojo_Form_Element_Dijit::_loadFilter()\Zend_Dojo_Form_Element_TextBox::_loadFilter()\Zend_Dojo_Form_Element_ValidationTextBox::_loadFilter()\Zend_Dojo_Form_Element_DateTextBox::_loadFilter()| Name | Type | Description |
|---|---|---|
| $filter | array |
| Type | Description |
|---|---|
| \Zend_Filter_Interface |

_loadValidator(array $validator) : \Zend_Validate_InterfaceLazy-load a validator
Inherited from: \Zend_Form_Element::_loadValidator()\Zend_Dojo_Form_Element_Dijit::_loadValidator()\Zend_Dojo_Form_Element_TextBox::_loadValidator()\Zend_Dojo_Form_Element_ValidationTextBox::_loadValidator()\Zend_Dojo_Form_Element_DateTextBox::_loadValidator()| Name | Type | Description |
|---|---|---|
| $validator | array | Validator definition |
| Type | Description |
|---|---|
| \Zend_Validate_Interface |

_validateIso8601(string $format) : trueValidate ISO 8601 time format
| Name | Type | Description |
|---|---|---|
| $format | string |
| Type | Description |
|---|---|
| true |
| Exception | Description |
|---|---|
| \Zend_Form_Element_Exception |

addDecorator(string | \Zend_Form_Decorator_Interface $decorator, array | \Zend_Config $options = null) : \Zend_Form_ElementAdd a decorator for rendering the element
Inherited from: \Zend_Form_Element::addDecorator()\Zend_Dojo_Form_Element_Dijit::addDecorator()\Zend_Dojo_Form_Element_TextBox::addDecorator()\Zend_Dojo_Form_Element_ValidationTextBox::addDecorator()\Zend_Dojo_Form_Element_DateTextBox::addDecorator()| Name | Type | Description |
|---|---|---|
| $decorator | string | \Zend_Form_Decorator_Interface | |
| $options | array | \Zend_Config | Options with which to initialize decorator |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addDecorators(array $decorators) : \Zend_Form_ElementAdd many decorators at once
Inherited from: \Zend_Form_Element::addDecorators()\Zend_Dojo_Form_Element_Dijit::addDecorators()\Zend_Dojo_Form_Element_TextBox::addDecorators()\Zend_Dojo_Form_Element_ValidationTextBox::addDecorators()\Zend_Dojo_Form_Element_DateTextBox::addDecorators()| Name | Type | Description |
|---|---|---|
| $decorators | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addError(string $message) : \Zend_Form_ElementAdd an error message and mark element as failed validation
Inherited from: \Zend_Form_Element::addError()\Zend_Dojo_Form_Element_Dijit::addError()\Zend_Dojo_Form_Element_TextBox::addError()\Zend_Dojo_Form_Element_ValidationTextBox::addError()\Zend_Dojo_Form_Element_DateTextBox::addError()| Name | Type | Description |
|---|---|---|
| $message | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addErrorMessage(string $message) : \Zend_Form_ElementAdd a custom error message to return in the event of failed validation
Inherited from: \Zend_Form_Element::addErrorMessage()\Zend_Dojo_Form_Element_Dijit::addErrorMessage()\Zend_Dojo_Form_Element_TextBox::addErrorMessage()\Zend_Dojo_Form_Element_ValidationTextBox::addErrorMessage()\Zend_Dojo_Form_Element_DateTextBox::addErrorMessage()| Name | Type | Description |
|---|---|---|
| $message | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addErrorMessages(array $messages) : \Zend_Form_ElementAdd multiple custom error messages to return in the event of failed validation
Inherited from: \Zend_Form_Element::addErrorMessages()\Zend_Dojo_Form_Element_Dijit::addErrorMessages()\Zend_Dojo_Form_Element_TextBox::addErrorMessages()\Zend_Dojo_Form_Element_ValidationTextBox::addErrorMessages()\Zend_Dojo_Form_Element_DateTextBox::addErrorMessages()| Name | Type | Description |
|---|---|---|
| $messages | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addErrors(array $messages) : \Zend_Form_ElementAdd multiple error messages and flag element as failed validation
Inherited from: \Zend_Form_Element::addErrors()\Zend_Dojo_Form_Element_Dijit::addErrors()\Zend_Dojo_Form_Element_TextBox::addErrors()\Zend_Dojo_Form_Element_ValidationTextBox::addErrors()\Zend_Dojo_Form_Element_DateTextBox::addErrors()| Name | Type | Description |
|---|---|---|
| $messages | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addFilter(string | \Zend_Filter_Interface $filter, $options = array()) : \Zend_Form_ElementAdd a filter to the element
Inherited from: \Zend_Form_Element::addFilter()\Zend_Dojo_Form_Element_Dijit::addFilter()\Zend_Dojo_Form_Element_TextBox::addFilter()\Zend_Dojo_Form_Element_ValidationTextBox::addFilter()\Zend_Dojo_Form_Element_DateTextBox::addFilter()| Name | Type | Description |
|---|---|---|
| $filter | string | \Zend_Filter_Interface | |
| $options |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addFilters(array $filters) : \Zend_Form_ElementAdd filters to element
Inherited from: \Zend_Form_Element::addFilters()\Zend_Dojo_Form_Element_Dijit::addFilters()\Zend_Dojo_Form_Element_TextBox::addFilters()\Zend_Dojo_Form_Element_ValidationTextBox::addFilters()\Zend_Dojo_Form_Element_DateTextBox::addFilters()| Name | Type | Description |
|---|---|---|
| $filters | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form_ElementAdd prefix path for plugin loader
Inherited from: \Zend_Form_Element::addPrefixPath()\Zend_Dojo_Form_Element_Dijit::addPrefixPath()\Zend_Dojo_Form_Element_TextBox::addPrefixPath()\Zend_Dojo_Form_Element_ValidationTextBox::addPrefixPath()\Zend_Dojo_Form_Element_DateTextBox::addPrefixPath()If no $type specified, assumes it is a base path for both filters and validators, and sets each according to the following rules: - decorators: $prefix = $prefix . '_Decorator' - filters: $prefix = $prefix . '_Filter' - validators: $prefix = $prefix . '_Validate'
Otherwise, the path prefix is set on the appropriate plugin loader.
| Name | Type | Description |
|---|---|---|
| $prefix | string | |
| $path | string | |
| $type | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |
| Exception | Description |
|---|---|
| \Zend_Form_Exception | for invalid type |

addPrefixPaths(array $spec) : \Zend_Form_ElementAdd many prefix paths at once
Inherited from: \Zend_Form_Element::addPrefixPaths()\Zend_Dojo_Form_Element_Dijit::addPrefixPaths()\Zend_Dojo_Form_Element_TextBox::addPrefixPaths()\Zend_Dojo_Form_Element_ValidationTextBox::addPrefixPaths()\Zend_Dojo_Form_Element_DateTextBox::addPrefixPaths()| Name | Type | Description |
|---|---|---|
| $spec | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addValidator(string | \Zend_Validate_Interface $validator, bool $breakChainOnFailure = false, array $options = array()) : \Zend_Form_ElementAdd validator to validation chain
Inherited from: \Zend_Form_Element::addValidator()\Zend_Dojo_Form_Element_Dijit::addValidator()\Zend_Dojo_Form_Element_TextBox::addValidator()\Zend_Dojo_Form_Element_ValidationTextBox::addValidator()\Zend_Dojo_Form_Element_DateTextBox::addValidator()Note: will overwrite existing validators if they are of the same class.
| Name | Type | Description |
|---|---|---|
| $validator | string | \Zend_Validate_Interface | |
| $breakChainOnFailure | bool | |
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |
| Exception | Description |
|---|---|
| \Zend_Form_Exception | if invalid validator type |

addValidators(array $validators) : \Zend_Form_ElementAdd multiple validators
Inherited from: \Zend_Form_Element::addValidators()\Zend_Dojo_Form_Element_Dijit::addValidators()\Zend_Dojo_Form_Element_TextBox::addValidators()\Zend_Dojo_Form_Element_ValidationTextBox::addValidators()\Zend_Dojo_Form_Element_DateTextBox::addValidators()| Name | Type | Description |
|---|---|---|
| $validators | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

autoInsertNotEmptyValidator() : boolGet flag indicating whether a NotEmpty validator should be inserted when element is required
Inherited from: \Zend_Form_Element::autoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_Dijit::autoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_TextBox::autoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_ValidationTextBox::autoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_DateTextBox::autoInsertNotEmptyValidator()| Type | Description |
|---|---|
| bool |

clearConstraints() : \Zend_Dojo_Form_Element_ValidationTextBoxClear all constraints
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::clearConstraints()\Zend_Dojo_Form_Element_DateTextBox::clearConstraints()| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ValidationTextBox |

clearDecorators() : \Zend_Form_ElementClear all decorators
Inherited from: \Zend_Form_Element::clearDecorators()\Zend_Dojo_Form_Element_Dijit::clearDecorators()\Zend_Dojo_Form_Element_TextBox::clearDecorators()\Zend_Dojo_Form_Element_ValidationTextBox::clearDecorators()\Zend_Dojo_Form_Element_DateTextBox::clearDecorators()| Type | Description |
|---|---|
| \Zend_Form_Element |

clearDijitParams() : \Zend_Dojo_Form_Element_DijitClear all dijit parameters
Inherited from: \Zend_Dojo_Form_Element_Dijit::clearDijitParams()\Zend_Dojo_Form_Element_TextBox::clearDijitParams()\Zend_Dojo_Form_Element_ValidationTextBox::clearDijitParams()\Zend_Dojo_Form_Element_DateTextBox::clearDijitParams()| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_Dijit |

clearErrorMessages() : \Zend_Form_ElementClear custom error messages stack
Inherited from: \Zend_Form_Element::clearErrorMessages()\Zend_Dojo_Form_Element_Dijit::clearErrorMessages()\Zend_Dojo_Form_Element_TextBox::clearErrorMessages()\Zend_Dojo_Form_Element_ValidationTextBox::clearErrorMessages()\Zend_Dojo_Form_Element_DateTextBox::clearErrorMessages()| Type | Description |
|---|---|
| \Zend_Form_Element |

clearFilters() : \Zend_Form_ElementClear all filters
Inherited from: \Zend_Form_Element::clearFilters()\Zend_Dojo_Form_Element_Dijit::clearFilters()\Zend_Dojo_Form_Element_TextBox::clearFilters()\Zend_Dojo_Form_Element_ValidationTextBox::clearFilters()\Zend_Dojo_Form_Element_DateTextBox::clearFilters()| Type | Description |
|---|---|
| \Zend_Form_Element |

clearValidators() : \Zend_Form_ElementClear all validators
Inherited from: \Zend_Form_Element::clearValidators()\Zend_Dojo_Form_Element_Dijit::clearValidators()\Zend_Dojo_Form_Element_TextBox::clearValidators()\Zend_Dojo_Form_Element_ValidationTextBox::clearValidators()\Zend_Dojo_Form_Element_DateTextBox::clearValidators()| Type | Description |
|---|---|
| \Zend_Form_Element |

filterName(string $value, bool $allowBrackets = false) : stringFilter a name to only allow valid variable characters
Inherited from: \Zend_Form_Element::filterName()\Zend_Dojo_Form_Element_Dijit::filterName()\Zend_Dojo_Form_Element_TextBox::filterName()\Zend_Dojo_Form_Element_ValidationTextBox::filterName()\Zend_Dojo_Form_Element_DateTextBox::filterName()| Name | Type | Description |
|---|---|---|
| $value | string | |
| $allowBrackets | bool |
| Type | Description |
|---|---|
| string |

getAllowEmpty() : boolGet 'allow empty' flag
Inherited from: \Zend_Form_Element::getAllowEmpty()\Zend_Dojo_Form_Element_Dijit::getAllowEmpty()\Zend_Dojo_Form_Element_TextBox::getAllowEmpty()\Zend_Dojo_Form_Element_ValidationTextBox::getAllowEmpty()\Zend_Dojo_Form_Element_DateTextBox::getAllowEmpty()| Type | Description |
|---|---|
| bool |

getAttrib(string $name) : stringRetrieve element attribute
Inherited from: \Zend_Form_Element::getAttrib()\Zend_Dojo_Form_Element_Dijit::getAttrib()\Zend_Dojo_Form_Element_TextBox::getAttrib()\Zend_Dojo_Form_Element_ValidationTextBox::getAttrib()\Zend_Dojo_Form_Element_DateTextBox::getAttrib()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| string |

getAttribs() : arrayReturn all attributes
Inherited from: \Zend_Form_Element::getAttribs()\Zend_Dojo_Form_Element_Dijit::getAttribs()\Zend_Dojo_Form_Element_TextBox::getAttribs()\Zend_Dojo_Form_Element_ValidationTextBox::getAttribs()\Zend_Dojo_Form_Element_DateTextBox::getAttribs()| Type | Description |
|---|---|
| array |

getBelongsTo() : stringReturn array name to which element belongs
Inherited from: \Zend_Form_Element::getBelongsTo()\Zend_Dojo_Form_Element_Dijit::getBelongsTo()\Zend_Dojo_Form_Element_TextBox::getBelongsTo()\Zend_Dojo_Form_Element_ValidationTextBox::getBelongsTo()\Zend_Dojo_Form_Element_DateTextBox::getBelongsTo()| Type | Description |
|---|---|
| string |

getClickableIncrement() : string | nullRetrieve clickableIncrement
| Type | Description |
|---|---|
| string | null |

getConstraint(string $key) : mixedGet an individual constraint
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::getConstraint()\Zend_Dojo_Form_Element_DateTextBox::getConstraint()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |

getConstraints() : arrayGet constraints
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::getConstraints()\Zend_Dojo_Form_Element_DateTextBox::getConstraints()| Type | Description |
|---|---|
| array |

getDatePattern() : string | nullRetrieve date format pattern
Inherited from: \Zend_Dojo_Form_Element_DateTextBox::getDatePattern()| Type | Description |
|---|---|
| string | null |

getDecorator(string $name) : false | \Zend_Form_Decorator_AbstractRetrieve a registered decorator
Inherited from: \Zend_Form_Element::getDecorator()\Zend_Dojo_Form_Element_Dijit::getDecorator()\Zend_Dojo_Form_Element_TextBox::getDecorator()\Zend_Dojo_Form_Element_ValidationTextBox::getDecorator()\Zend_Dojo_Form_Element_DateTextBox::getDecorator()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| false | \Zend_Form_Decorator_Abstract |

getDecorators() : arrayRetrieve all decorators
Inherited from: \Zend_Form_Element::getDecorators()\Zend_Dojo_Form_Element_Dijit::getDecorators()\Zend_Dojo_Form_Element_TextBox::getDecorators()\Zend_Dojo_Form_Element_ValidationTextBox::getDecorators()\Zend_Dojo_Form_Element_DateTextBox::getDecorators()| Type | Description |
|---|---|
| array |

getDescription() : stringRetrieve element description
Inherited from: \Zend_Form_Element::getDescription()\Zend_Dojo_Form_Element_Dijit::getDescription()\Zend_Dojo_Form_Element_TextBox::getDescription()\Zend_Dojo_Form_Element_ValidationTextBox::getDescription()\Zend_Dojo_Form_Element_DateTextBox::getDescription()| Type | Description |
|---|---|
| string |

getDijitParam(string $key) : mixedGet a single dijit parameter
Inherited from: \Zend_Dojo_Form_Element_Dijit::getDijitParam()\Zend_Dojo_Form_Element_TextBox::getDijitParam()\Zend_Dojo_Form_Element_ValidationTextBox::getDijitParam()\Zend_Dojo_Form_Element_DateTextBox::getDijitParam()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |

getDijitParams() : arrayRetrieve all dijit parameters
Inherited from: \Zend_Dojo_Form_Element_Dijit::getDijitParams()\Zend_Dojo_Form_Element_TextBox::getDijitParams()\Zend_Dojo_Form_Element_ValidationTextBox::getDijitParams()\Zend_Dojo_Form_Element_DateTextBox::getDijitParams()| Type | Description |
|---|---|
| array |

getErrorMessageSeparator() : stringGet errorMessageSeparator
Inherited from: \Zend_Form_Element::getErrorMessageSeparator()\Zend_Dojo_Form_Element_Dijit::getErrorMessageSeparator()\Zend_Dojo_Form_Element_TextBox::getErrorMessageSeparator()\Zend_Dojo_Form_Element_ValidationTextBox::getErrorMessageSeparator()\Zend_Dojo_Form_Element_DateTextBox::getErrorMessageSeparator()| Type | Description |
|---|---|
| string |

getErrorMessages() : arrayRetrieve custom error messages
Inherited from: \Zend_Form_Element::getErrorMessages()\Zend_Dojo_Form_Element_Dijit::getErrorMessages()\Zend_Dojo_Form_Element_TextBox::getErrorMessages()\Zend_Dojo_Form_Element_ValidationTextBox::getErrorMessages()\Zend_Dojo_Form_Element_DateTextBox::getErrorMessages()| Type | Description |
|---|---|
| array |

getErrors() : arrayRetrieve validator chain errors
Inherited from: \Zend_Form_Element::getErrors()\Zend_Dojo_Form_Element_Dijit::getErrors()\Zend_Dojo_Form_Element_TextBox::getErrors()\Zend_Dojo_Form_Element_ValidationTextBox::getErrors()\Zend_Dojo_Form_Element_DateTextBox::getErrors()| Type | Description |
|---|---|
| array |

getFilter(string $name) : \Zend_Filter_InterfaceRetrieve a single filter by name
Inherited from: \Zend_Form_Element::getFilter()\Zend_Dojo_Form_Element_Dijit::getFilter()\Zend_Dojo_Form_Element_TextBox::getFilter()\Zend_Dojo_Form_Element_ValidationTextBox::getFilter()\Zend_Dojo_Form_Element_DateTextBox::getFilter()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Filter_Interface |

getFilters() : arrayGet all filters
Inherited from: \Zend_Form_Element::getFilters()\Zend_Dojo_Form_Element_Dijit::getFilters()\Zend_Dojo_Form_Element_TextBox::getFilters()\Zend_Dojo_Form_Element_ValidationTextBox::getFilters()\Zend_Dojo_Form_Element_DateTextBox::getFilters()| Type | Description |
|---|---|
| array |

getFormatLength() : string | nullRetrieve formatLength
Inherited from: \Zend_Dojo_Form_Element_DateTextBox::getFormatLength()| Type | Description |
|---|---|
| string | null |

getFullyQualifiedName() : stringGet fully qualified name
Inherited from: \Zend_Form_Element::getFullyQualifiedName()\Zend_Dojo_Form_Element_Dijit::getFullyQualifiedName()\Zend_Dojo_Form_Element_TextBox::getFullyQualifiedName()\Zend_Dojo_Form_Element_ValidationTextBox::getFullyQualifiedName()\Zend_Dojo_Form_Element_DateTextBox::getFullyQualifiedName()Places name as subitem of array and/or appends brackets.
| Type | Description |
|---|---|
| string |

getId() : stringGet element id
Inherited from: \Zend_Form_Element::getId()\Zend_Dojo_Form_Element_Dijit::getId()\Zend_Dojo_Form_Element_TextBox::getId()\Zend_Dojo_Form_Element_ValidationTextBox::getId()\Zend_Dojo_Form_Element_DateTextBox::getId()| Type | Description |
|---|---|
| string |

getIgnore() : boolGet ignore flag (used when retrieving values at form level)
Inherited from: \Zend_Form_Element::getIgnore()\Zend_Dojo_Form_Element_Dijit::getIgnore()\Zend_Dojo_Form_Element_TextBox::getIgnore()\Zend_Dojo_Form_Element_ValidationTextBox::getIgnore()\Zend_Dojo_Form_Element_DateTextBox::getIgnore()| Type | Description |
|---|---|
| bool |

getInvalidMessage() : string | nullRetrieve invalidMessage
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::getInvalidMessage()\Zend_Dojo_Form_Element_DateTextBox::getInvalidMessage()| Type | Description |
|---|---|
| string | null |

getLabel() : stringRetrieve element label
Inherited from: \Zend_Form_Element::getLabel()\Zend_Dojo_Form_Element_Dijit::getLabel()\Zend_Dojo_Form_Element_TextBox::getLabel()\Zend_Dojo_Form_Element_ValidationTextBox::getLabel()\Zend_Dojo_Form_Element_DateTextBox::getLabel()| Type | Description |
|---|---|
| string |

getLowercase() : boolRetrieve lowercase flag
Inherited from: \Zend_Dojo_Form_Element_TextBox::getLowercase()\Zend_Dojo_Form_Element_ValidationTextBox::getLowercase()\Zend_Dojo_Form_Element_DateTextBox::getLowercase()| Type | Description |
|---|---|
| bool |

getMaxLength() : int | nullRetrieve maxLength
Inherited from: \Zend_Dojo_Form_Element_TextBox::getMaxLength()\Zend_Dojo_Form_Element_ValidationTextBox::getMaxLength()\Zend_Dojo_Form_Element_DateTextBox::getMaxLength()| Type | Description |
|---|---|
| int | null |

getMessages() : arrayRetrieve error messages
Inherited from: \Zend_Form_Element::getMessages()\Zend_Dojo_Form_Element_Dijit::getMessages()\Zend_Dojo_Form_Element_TextBox::getMessages()\Zend_Dojo_Form_Element_ValidationTextBox::getMessages()\Zend_Dojo_Form_Element_DateTextBox::getMessages()The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.
If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.
| Type | Description |
|---|---|
| array |

getName() : stringReturn element name
Inherited from: \Zend_Form_Element::getName()\Zend_Dojo_Form_Element_Dijit::getName()\Zend_Dojo_Form_Element_TextBox::getName()\Zend_Dojo_Form_Element_ValidationTextBox::getName()\Zend_Dojo_Form_Element_DateTextBox::getName()| Type | Description |
|---|---|
| string |

getOrder() : intRetrieve element order
Inherited from: \Zend_Form_Element::getOrder()\Zend_Dojo_Form_Element_Dijit::getOrder()\Zend_Dojo_Form_Element_TextBox::getOrder()\Zend_Dojo_Form_Element_ValidationTextBox::getOrder()\Zend_Dojo_Form_Element_DateTextBox::getOrder()| Type | Description |
|---|---|
| int |

getPluginLoader(string $type) : \Zend_Loader_PluginLoaderRetrieve plugin loader for validator or filter chain
Inherited from: \Zend_Form_Element::getPluginLoader()\Zend_Dojo_Form_Element_Dijit::getPluginLoader()\Zend_Dojo_Form_Element_TextBox::getPluginLoader()\Zend_Dojo_Form_Element_ValidationTextBox::getPluginLoader()\Zend_Dojo_Form_Element_DateTextBox::getPluginLoader()Instantiates with default rules if none available for that type. Use 'decorator', 'filter', or 'validate' for $type.
| Name | Type | Description |
|---|---|---|
| $type | string |
| Type | Description |
|---|---|
| \Zend_Loader_PluginLoader |
| Exception | Description |
|---|---|
| \Zend_Loader_Exception | on invalid type. |

getPromptMessage() : string | nullRetrieve promptMessage
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::getPromptMessage()\Zend_Dojo_Form_Element_DateTextBox::getPromptMessage()| Type | Description |
|---|---|
| string | null |

getPropercase() : boolRetrieve propercase flag
Inherited from: \Zend_Dojo_Form_Element_TextBox::getPropercase()\Zend_Dojo_Form_Element_ValidationTextBox::getPropercase()\Zend_Dojo_Form_Element_DateTextBox::getPropercase()| Type | Description |
|---|---|
| bool |

getRegExp() : string | nullRetrieve regExp
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::getRegExp()\Zend_Dojo_Form_Element_DateTextBox::getRegExp()| Type | Description |
|---|---|
| string | null |

getTranslator() : \Zend_Translate_Adapter | nullRetrieve localization translator object
Inherited from: \Zend_Form_Element::getTranslator()\Zend_Dojo_Form_Element_Dijit::getTranslator()\Zend_Dojo_Form_Element_TextBox::getTranslator()\Zend_Dojo_Form_Element_ValidationTextBox::getTranslator()\Zend_Dojo_Form_Element_DateTextBox::getTranslator()| Type | Description |
|---|---|
| \Zend_Translate_Adapter | null |

getTrim() : boolRetrieve trim flag
Inherited from: \Zend_Dojo_Form_Element_TextBox::getTrim()\Zend_Dojo_Form_Element_ValidationTextBox::getTrim()\Zend_Dojo_Form_Element_DateTextBox::getTrim()| Type | Description |
|---|---|
| bool |

getType() : stringReturn element type
Inherited from: \Zend_Form_Element::getType()\Zend_Dojo_Form_Element_Dijit::getType()\Zend_Dojo_Form_Element_TextBox::getType()\Zend_Dojo_Form_Element_ValidationTextBox::getType()\Zend_Dojo_Form_Element_DateTextBox::getType()| Type | Description |
|---|---|
| string |

getUnfilteredValue() : mixedRetrieve unfiltered element value
Inherited from: \Zend_Form_Element::getUnfilteredValue()\Zend_Dojo_Form_Element_Dijit::getUnfilteredValue()\Zend_Dojo_Form_Element_TextBox::getUnfilteredValue()\Zend_Dojo_Form_Element_ValidationTextBox::getUnfilteredValue()\Zend_Dojo_Form_Element_DateTextBox::getUnfilteredValue()| Type | Description |
|---|---|
| mixed |

getUppercase() : boolRetrieve uppercase flag
Inherited from: \Zend_Dojo_Form_Element_TextBox::getUppercase()\Zend_Dojo_Form_Element_ValidationTextBox::getUppercase()\Zend_Dojo_Form_Element_DateTextBox::getUppercase()| Type | Description |
|---|---|
| bool |

getValidator(string $name) : \Zend_Validate_Interface | falseRetrieve a single validator by name
Inherited from: \Zend_Form_Element::getValidator()\Zend_Dojo_Form_Element_Dijit::getValidator()\Zend_Dojo_Form_Element_TextBox::getValidator()\Zend_Dojo_Form_Element_ValidationTextBox::getValidator()\Zend_Dojo_Form_Element_DateTextBox::getValidator()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Validate_Interface | false | False if not found, validator otherwise |

getValidators() : arrayRetrieve all validators
Inherited from: \Zend_Form_Element::getValidators()\Zend_Dojo_Form_Element_Dijit::getValidators()\Zend_Dojo_Form_Element_TextBox::getValidators()\Zend_Dojo_Form_Element_ValidationTextBox::getValidators()\Zend_Dojo_Form_Element_DateTextBox::getValidators()| Type | Description |
|---|---|
| array |

getValue() : mixedRetrieve filtered element value
Inherited from: \Zend_Form_Element::getValue()\Zend_Dojo_Form_Element_Dijit::getValue()\Zend_Dojo_Form_Element_TextBox::getValue()\Zend_Dojo_Form_Element_ValidationTextBox::getValue()\Zend_Dojo_Form_Element_DateTextBox::getValue()| Type | Description |
|---|---|
| mixed |

getView() : null | \Zend_View_InterfaceRetrieve view object
Inherited from: \Zend_Form_Element::getView()\Zend_Dojo_Form_Element_Dijit::getView()\Zend_Dojo_Form_Element_TextBox::getView()\Zend_Dojo_Form_Element_ValidationTextBox::getView()\Zend_Dojo_Form_Element_DateTextBox::getView()Retrieves from ViewRenderer if none previously set.
| Type | Description |
|---|---|
| null | \Zend_View_Interface |

hasConstraint(string $key) : boolIs the given constraint set?
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::hasConstraint()\Zend_Dojo_Form_Element_DateTextBox::hasConstraint()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| bool |

hasDijitParam(string $key) : boolDoes the given dijit parameter exist?
Inherited from: \Zend_Dojo_Form_Element_Dijit::hasDijitParam()\Zend_Dojo_Form_Element_TextBox::hasDijitParam()\Zend_Dojo_Form_Element_ValidationTextBox::hasDijitParam()\Zend_Dojo_Form_Element_DateTextBox::hasDijitParam()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| bool |

hasErrors() : boolAre there errors registered?
Inherited from: \Zend_Form_Element::hasErrors()\Zend_Dojo_Form_Element_Dijit::hasErrors()\Zend_Dojo_Form_Element_TextBox::hasErrors()\Zend_Dojo_Form_Element_ValidationTextBox::hasErrors()\Zend_Dojo_Form_Element_DateTextBox::hasErrors()| Type | Description |
|---|---|
| bool |

hasTranslator() : boolDoes this element have its own specific translator?
Inherited from: \Zend_Form_Element::hasTranslator()\Zend_Dojo_Form_Element_Dijit::hasTranslator()\Zend_Dojo_Form_Element_TextBox::hasTranslator()\Zend_Dojo_Form_Element_ValidationTextBox::hasTranslator()\Zend_Dojo_Form_Element_DateTextBox::hasTranslator()| Type | Description |
|---|---|
| bool |

init() : voidInitialize object; used by extending classes
Inherited from: \Zend_Form_Element::init()\Zend_Dojo_Form_Element_Dijit::init()\Zend_Dojo_Form_Element_TextBox::init()\Zend_Dojo_Form_Element_ValidationTextBox::init()\Zend_Dojo_Form_Element_DateTextBox::init()
isArray() : boolIs the element representing an array?
Inherited from: \Zend_Form_Element::isArray()\Zend_Dojo_Form_Element_Dijit::isArray()\Zend_Dojo_Form_Element_TextBox::isArray()\Zend_Dojo_Form_Element_ValidationTextBox::isArray()\Zend_Dojo_Form_Element_DateTextBox::isArray()| Type | Description |
|---|---|
| bool |

isRequired() : boolIs the element required?
Inherited from: \Zend_Form_Element::isRequired()\Zend_Dojo_Form_Element_Dijit::isRequired()\Zend_Dojo_Form_Element_TextBox::isRequired()\Zend_Dojo_Form_Element_ValidationTextBox::isRequired()\Zend_Dojo_Form_Element_DateTextBox::isRequired()| Type | Description |
|---|---|
| bool |

isValid(mixed $value, mixed $context = null) : booleanValidate element value
Inherited from: \Zend_Form_Element::isValid()\Zend_Dojo_Form_Element_Dijit::isValid()\Zend_Dojo_Form_Element_TextBox::isValid()\Zend_Dojo_Form_Element_ValidationTextBox::isValid()\Zend_Dojo_Form_Element_DateTextBox::isValid()If a translation adapter is registered, any error messages will be translated according to the current locale, using the given error code; if no matching translation is found, the original message will be utilized.
Note: The filtered value is validated.
| Name | Type | Description |
|---|---|---|
| $value | mixed | |
| $context | mixed |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Validate_Exception | If validation of $value is impossible |

loadDefaultDecorators() : voidLoad default decorators
Inherited from: \Zend_Dojo_Form_Element_Dijit::loadDefaultDecorators()\Zend_Dojo_Form_Element_TextBox::loadDefaultDecorators()\Zend_Dojo_Form_Element_ValidationTextBox::loadDefaultDecorators()\Zend_Dojo_Form_Element_DateTextBox::loadDefaultDecorators()
loadDefaultDecoratorsIsDisabled() : boolShould we load the default decorators?
Inherited from: \Zend_Form_Element::loadDefaultDecoratorsIsDisabled()\Zend_Dojo_Form_Element_Dijit::loadDefaultDecoratorsIsDisabled()\Zend_Dojo_Form_Element_TextBox::loadDefaultDecoratorsIsDisabled()\Zend_Dojo_Form_Element_ValidationTextBox::loadDefaultDecoratorsIsDisabled()\Zend_Dojo_Form_Element_DateTextBox::loadDefaultDecoratorsIsDisabled()| Type | Description |
|---|---|
| bool |

markAsError() : \Zend_Form_ElementMark the element as being in a failed validation state
Inherited from: \Zend_Form_Element::markAsError()\Zend_Dojo_Form_Element_Dijit::markAsError()\Zend_Dojo_Form_Element_TextBox::markAsError()\Zend_Dojo_Form_Element_ValidationTextBox::markAsError()\Zend_Dojo_Form_Element_DateTextBox::markAsError()| Type | Description |
|---|---|
| \Zend_Form_Element |

removeConstraint(string $key) : \Zend_Dojo_Form_Element_ValidationTextBoxRemove a single constraint
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::removeConstraint()\Zend_Dojo_Form_Element_DateTextBox::removeConstraint()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ValidationTextBox |

removeDecorator(string $name) : \Zend_Form_ElementRemove a single decorator
Inherited from: \Zend_Form_Element::removeDecorator()\Zend_Dojo_Form_Element_Dijit::removeDecorator()\Zend_Dojo_Form_Element_TextBox::removeDecorator()\Zend_Dojo_Form_Element_ValidationTextBox::removeDecorator()\Zend_Dojo_Form_Element_DateTextBox::removeDecorator()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

removeDijitParam(string $key) : \Zend_Dojo_Form_Element_DijitRemove a single dijit parameter
Inherited from: \Zend_Dojo_Form_Element_Dijit::removeDijitParam()\Zend_Dojo_Form_Element_TextBox::removeDijitParam()\Zend_Dojo_Form_Element_ValidationTextBox::removeDijitParam()\Zend_Dojo_Form_Element_DateTextBox::removeDijitParam()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_Dijit |

removeFilter(string $name) : \Zend_Form_ElementRemove a filter by name
Inherited from: \Zend_Form_Element::removeFilter()\Zend_Dojo_Form_Element_Dijit::removeFilter()\Zend_Dojo_Form_Element_TextBox::removeFilter()\Zend_Dojo_Form_Element_ValidationTextBox::removeFilter()\Zend_Dojo_Form_Element_DateTextBox::removeFilter()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

removeValidator(string $name) : boolRemove a single validator by name
Inherited from: \Zend_Form_Element::removeValidator()\Zend_Dojo_Form_Element_Dijit::removeValidator()\Zend_Dojo_Form_Element_TextBox::removeValidator()\Zend_Dojo_Form_Element_ValidationTextBox::removeValidator()\Zend_Dojo_Form_Element_DateTextBox::removeValidator()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| bool |

render(\Zend_View_Interface $view = null) : stringRender form element
Inherited from: \Zend_Form_Element::render()\Zend_Dojo_Form_Element_Dijit::render()\Zend_Dojo_Form_Element_TextBox::render()\Zend_Dojo_Form_Element_ValidationTextBox::render()\Zend_Dojo_Form_Element_DateTextBox::render()| Name | Type | Description |
|---|---|---|
| $view | \Zend_View_Interface |
| Type | Description |
|---|---|
| string |

resolveElementId(\Zend_Form_Decorator_Interface $decorator) : stringUsed to resolve and return an element ID
Inherited from: \Zend_Form_Element::resolveElementId()\Zend_Dojo_Form_Element_Dijit::resolveElementId()\Zend_Dojo_Form_Element_TextBox::resolveElementId()\Zend_Dojo_Form_Element_ValidationTextBox::resolveElementId()\Zend_Dojo_Form_Element_DateTextBox::resolveElementId()Passed to the HtmlTag decorator as a callback in order to provide an ID.
| Name | Type | Description |
|---|---|---|
| $decorator | \Zend_Form_Decorator_Interface |
| Type | Description |
|---|---|
| string |

setAllowEmpty(bool $flag) : \Zend_Form_ElementSet 'allow empty' flag
Inherited from: \Zend_Form_Element::setAllowEmpty()\Zend_Dojo_Form_Element_Dijit::setAllowEmpty()\Zend_Dojo_Form_Element_TextBox::setAllowEmpty()\Zend_Dojo_Form_Element_ValidationTextBox::setAllowEmpty()\Zend_Dojo_Form_Element_DateTextBox::setAllowEmpty()When the allow empty flag is enabled and the required flag is false, the element will validate with empty values.
| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setAmPm( $flag) : \Zend_Dojo_Form_Element_DateTextBox| Name | Type | Description |
|---|---|---|
| $flag |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_DateTextBox |

setAttrib(string $name, mixed $value) : \Zend_Form_ElementSet element attribute
Inherited from: \Zend_Form_Element::setAttrib()\Zend_Dojo_Form_Element_Dijit::setAttrib()\Zend_Dojo_Form_Element_TextBox::setAttrib()\Zend_Dojo_Form_Element_ValidationTextBox::setAttrib()\Zend_Dojo_Form_Element_DateTextBox::setAttrib()| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Form_Element |
| Exception | Description |
|---|---|
| \Zend_Form_Exception | for invalid $name values |

setAttribs(array $attribs) : \Zend_Form_ElementSet multiple attributes at once
Inherited from: \Zend_Form_Element::setAttribs()\Zend_Dojo_Form_Element_Dijit::setAttribs()\Zend_Dojo_Form_Element_TextBox::setAttribs()\Zend_Dojo_Form_Element_ValidationTextBox::setAttribs()\Zend_Dojo_Form_Element_DateTextBox::setAttribs()| Name | Type | Description |
|---|---|---|
| $attribs | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setAutoInsertNotEmptyValidator(bool $flag) : \Zend_Form_ElementSet flag indicating whether a NotEmpty validator should be inserted when element is required
Inherited from: \Zend_Form_Element::setAutoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_Dijit::setAutoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_TextBox::setAutoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_ValidationTextBox::setAutoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_DateTextBox::setAutoInsertNotEmptyValidator()| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setBelongsTo(string $array) : \Zend_Form_ElementSet array to which element belongs
Inherited from: \Zend_Form_Element::setBelongsTo()\Zend_Dojo_Form_Element_Dijit::setBelongsTo()\Zend_Dojo_Form_Element_TextBox::setBelongsTo()\Zend_Dojo_Form_Element_ValidationTextBox::setBelongsTo()\Zend_Dojo_Form_Element_DateTextBox::setBelongsTo()| Name | Type | Description |
|---|---|---|
| $array | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setClickableIncrement(string $format) : \Zend_Dojo_Form_Element_NumberTextBoxSet clickableIncrement
| Name | Type | Description |
|---|---|---|
| $format | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_NumberTextBox |

setConfig(\Zend_Config $config) : \Zend_Form_ElementSet object state from Zend_Config object
Inherited from: \Zend_Form_Element::setConfig()\Zend_Dojo_Form_Element_Dijit::setConfig()\Zend_Dojo_Form_Element_TextBox::setConfig()\Zend_Dojo_Form_Element_ValidationTextBox::setConfig()\Zend_Dojo_Form_Element_DateTextBox::setConfig()| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setConstraint(string $key, mixed $value) : \Zend_Dojo_Form_Element_ValidationTextBoxSet an individual constraint
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::setConstraint()\Zend_Dojo_Form_Element_DateTextBox::setConstraint()| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ValidationTextBox |

setConstraints(array $constraints) : \Zend_Dojo_Form_Element_ValidationTextBoxSet validation constraints
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::setConstraints()\Zend_Dojo_Form_Element_DateTextBox::setConstraints()Refer to Dojo dijit.form.ValidationTextBox documentation for valid structure.
| Name | Type | Description |
|---|---|---|
| $constraints | array |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ValidationTextBox |

setDatePattern(string $pattern) : \Zend_Dojo_Form_Element_NumberTextBoxSet date format pattern
Inherited from: \Zend_Dojo_Form_Element_DateTextBox::setDatePattern()| Name | Type | Description |
|---|---|---|
| $pattern | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_NumberTextBox |

setDecorators(array $decorators) : \Zend_Form_ElementOverwrite all decorators
Inherited from: \Zend_Form_Element::setDecorators()\Zend_Dojo_Form_Element_Dijit::setDecorators()\Zend_Dojo_Form_Element_TextBox::setDecorators()\Zend_Dojo_Form_Element_ValidationTextBox::setDecorators()\Zend_Dojo_Form_Element_DateTextBox::setDecorators()| Name | Type | Description |
|---|---|---|
| $decorators | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setDescription(string $description) : \Zend_Form_ElementSet element description
Inherited from: \Zend_Form_Element::setDescription()\Zend_Dojo_Form_Element_Dijit::setDescription()\Zend_Dojo_Form_Element_TextBox::setDescription()\Zend_Dojo_Form_Element_ValidationTextBox::setDescription()\Zend_Dojo_Form_Element_DateTextBox::setDescription()| Name | Type | Description |
|---|---|---|
| $description | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setDijitParam(string $key, mixed $value) : \Zend_Dojo_Form_Element_DijitSet a dijit parameter
Inherited from: \Zend_Dojo_Form_Element_Dijit::setDijitParam()\Zend_Dojo_Form_Element_TextBox::setDijitParam()\Zend_Dojo_Form_Element_ValidationTextBox::setDijitParam()\Zend_Dojo_Form_Element_DateTextBox::setDijitParam()| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_Dijit |

setDijitParams(array $params) : \Zend_Dojo_Form_Element_DijitSet multiple dijit params at once
Inherited from: \Zend_Dojo_Form_Element_Dijit::setDijitParams()\Zend_Dojo_Form_Element_TextBox::setDijitParams()\Zend_Dojo_Form_Element_ValidationTextBox::setDijitParams()\Zend_Dojo_Form_Element_DateTextBox::setDijitParams()| Name | Type | Description |
|---|---|---|
| $params | array |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_Dijit |

setDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_ElementSet flag to disable loading default decorators
Inherited from: \Zend_Form_Element::setDisableLoadDefaultDecorators()\Zend_Dojo_Form_Element_Dijit::setDisableLoadDefaultDecorators()\Zend_Dojo_Form_Element_TextBox::setDisableLoadDefaultDecorators()\Zend_Dojo_Form_Element_ValidationTextBox::setDisableLoadDefaultDecorators()\Zend_Dojo_Form_Element_DateTextBox::setDisableLoadDefaultDecorators()| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setDisableTranslator(bool $flag) : \Zend_Form_ElementIndicate whether or not translation should be disabled
Inherited from: \Zend_Form_Element::setDisableTranslator()\Zend_Dojo_Form_Element_Dijit::setDisableTranslator()\Zend_Dojo_Form_Element_TextBox::setDisableTranslator()\Zend_Dojo_Form_Element_ValidationTextBox::setDisableTranslator()\Zend_Dojo_Form_Element_DateTextBox::setDisableTranslator()| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setErrorMessageSeparator(string $separator) : \Zend_Form_ElementSet errorMessageSeparator
Inherited from: \Zend_Form_Element::setErrorMessageSeparator()\Zend_Dojo_Form_Element_Dijit::setErrorMessageSeparator()\Zend_Dojo_Form_Element_TextBox::setErrorMessageSeparator()\Zend_Dojo_Form_Element_ValidationTextBox::setErrorMessageSeparator()\Zend_Dojo_Form_Element_DateTextBox::setErrorMessageSeparator()| Name | Type | Description |
|---|---|---|
| $separator | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setErrorMessages(array $messages) : \Zend_Form_ElementSame as addErrorMessages(), but clears custom error message stack first
Inherited from: \Zend_Form_Element::setErrorMessages()\Zend_Dojo_Form_Element_Dijit::setErrorMessages()\Zend_Dojo_Form_Element_TextBox::setErrorMessages()\Zend_Dojo_Form_Element_ValidationTextBox::setErrorMessages()\Zend_Dojo_Form_Element_DateTextBox::setErrorMessages()| Name | Type | Description |
|---|---|---|
| $messages | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setErrors(array $messages) : \Zend_Form_ElementOverwrite any previously set error messages and flag as failed validation
Inherited from: \Zend_Form_Element::setErrors()\Zend_Dojo_Form_Element_Dijit::setErrors()\Zend_Dojo_Form_Element_TextBox::setErrors()\Zend_Dojo_Form_Element_ValidationTextBox::setErrors()\Zend_Dojo_Form_Element_DateTextBox::setErrors()| Name | Type | Description |
|---|---|---|
| $messages | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setFilters(array $filters) : \Zend_Form_ElementAdd filters to element, overwriting any already existing
Inherited from: \Zend_Form_Element::setFilters()\Zend_Dojo_Form_Element_Dijit::setFilters()\Zend_Dojo_Form_Element_TextBox::setFilters()\Zend_Dojo_Form_Element_ValidationTextBox::setFilters()\Zend_Dojo_Form_Element_DateTextBox::setFilters()| Name | Type | Description |
|---|---|---|
| $filters | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setFormatLength(string $formatLength) : \Zend_Dojo_Form_Element_NumberTextBoxSet numeric format formatLength
Inherited from: \Zend_Dojo_Form_Element_DateTextBox::setFormatLength()| Name | Type | Description |
|---|---|---|
| $formatLength | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_NumberTextBox |
- See
- \$_allowedFormatTypes

setIgnore(bool $flag) : \Zend_Form_ElementSet ignore flag (used when retrieving values at form level)
Inherited from: \Zend_Form_Element::setIgnore()\Zend_Dojo_Form_Element_Dijit::setIgnore()\Zend_Dojo_Form_Element_TextBox::setIgnore()\Zend_Dojo_Form_Element_ValidationTextBox::setIgnore()\Zend_Dojo_Form_Element_DateTextBox::setIgnore()| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setInvalidMessage(string $message) : \Zend_Dojo_Form_Element_ValidationTextBoxSet invalidMessage
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::setInvalidMessage()\Zend_Dojo_Form_Element_DateTextBox::setInvalidMessage()| Name | Type | Description |
|---|---|---|
| $message | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ValidationTextBox |

setIsArray(bool $flag) : \Zend_Form_ElementSet flag indicating if element represents an array
Inherited from: \Zend_Form_Element::setIsArray()\Zend_Dojo_Form_Element_Dijit::setIsArray()\Zend_Dojo_Form_Element_TextBox::setIsArray()\Zend_Dojo_Form_Element_ValidationTextBox::setIsArray()\Zend_Dojo_Form_Element_DateTextBox::setIsArray()| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setLabel(string $label) : \Zend_Form_ElementSet element label
Inherited from: \Zend_Form_Element::setLabel()\Zend_Dojo_Form_Element_Dijit::setLabel()\Zend_Dojo_Form_Element_TextBox::setLabel()\Zend_Dojo_Form_Element_ValidationTextBox::setLabel()\Zend_Dojo_Form_Element_DateTextBox::setLabel()| Name | Type | Description |
|---|---|---|
| $label | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setLocale(string $locale) : \Zend_Dojo_Form_Element_DateTextBox| Name | Type | Description |
|---|---|---|
| $locale | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_DateTextBox |

setLowercase( $flag) : \Zend_Dojo_Form_Element_TextBoxSet lowercase flag
Inherited from: \Zend_Dojo_Form_Element_TextBox::setLowercase()\Zend_Dojo_Form_Element_ValidationTextBox::setLowercase()\Zend_Dojo_Form_Element_DateTextBox::setLowercase()| Name | Type | Description |
|---|---|---|
| $flag |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_TextBox |

setMaxLength(int $length) : \Zend_Dojo_Form_Element_TextBoxSet maxLength
Inherited from: \Zend_Dojo_Form_Element_TextBox::setMaxLength()\Zend_Dojo_Form_Element_ValidationTextBox::setMaxLength()\Zend_Dojo_Form_Element_DateTextBox::setMaxLength()| Name | Type | Description |
|---|---|---|
| $length | int |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_TextBox |

setName(string $name) : \Zend_Form_ElementSet element name
Inherited from: \Zend_Form_Element::setName()\Zend_Dojo_Form_Element_Dijit::setName()\Zend_Dojo_Form_Element_TextBox::setName()\Zend_Dojo_Form_Element_ValidationTextBox::setName()\Zend_Dojo_Form_Element_DateTextBox::setName()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setOptions(array $options) : \Zend_Form_ElementSet object state from options array
Inherited from: \Zend_Form_Element::setOptions()\Zend_Dojo_Form_Element_Dijit::setOptions()\Zend_Dojo_Form_Element_TextBox::setOptions()\Zend_Dojo_Form_Element_ValidationTextBox::setOptions()\Zend_Dojo_Form_Element_DateTextBox::setOptions()| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setOrder(int $order) : \Zend_Form_ElementSet element order
Inherited from: \Zend_Form_Element::setOrder()\Zend_Dojo_Form_Element_Dijit::setOrder()\Zend_Dojo_Form_Element_TextBox::setOrder()\Zend_Dojo_Form_Element_ValidationTextBox::setOrder()\Zend_Dojo_Form_Element_DateTextBox::setOrder()| Name | Type | Description |
|---|---|---|
| $order | int |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type) : \Zend_Form_ElementSet plugin loader to use for validator or filter chain
Inherited from: \Zend_Form_Element::setPluginLoader()\Zend_Dojo_Form_Element_Dijit::setPluginLoader()\Zend_Dojo_Form_Element_TextBox::setPluginLoader()\Zend_Dojo_Form_Element_ValidationTextBox::setPluginLoader()\Zend_Dojo_Form_Element_DateTextBox::setPluginLoader()| Name | Type | Description |
|---|---|---|
| $loader | \Zend_Loader_PluginLoader_Interface | |
| $type | string | 'decorator', 'filter', or 'validate' |
| Type | Description |
|---|---|
| \Zend_Form_Element |
| Exception | Description |
|---|---|
| \Zend_Form_Exception | on invalid type |

setPromptMessage(string $message) : \Zend_Dojo_Form_Element_ValidationTextBoxSet promptMessage
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::setPromptMessage()\Zend_Dojo_Form_Element_DateTextBox::setPromptMessage()| Name | Type | Description |
|---|---|---|
| $message | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ValidationTextBox |

setPropercase( $flag) : \Zend_Dojo_Form_Element_TextBoxSet propercase flag
Inherited from: \Zend_Dojo_Form_Element_TextBox::setPropercase()\Zend_Dojo_Form_Element_ValidationTextBox::setPropercase()\Zend_Dojo_Form_Element_DateTextBox::setPropercase()| Name | Type | Description |
|---|---|---|
| $flag |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_TextBox |

setRegExp(string $regexp) : \Zend_Dojo_Form_Element_ValidationTextBoxSet regExp
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::setRegExp()\Zend_Dojo_Form_Element_DateTextBox::setRegExp()| Name | Type | Description |
|---|---|---|
| $regexp | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ValidationTextBox |

setRequired(bool $flag = true) : \Zend_Form_ElementSet required flag
Inherited from: \Zend_Form_Element::setRequired()\Zend_Dojo_Form_Element_Dijit::setRequired()\Zend_Dojo_Form_Element_TextBox::setRequired()\Zend_Dojo_Form_Element_ValidationTextBox::setRequired()\Zend_Dojo_Form_Element_DateTextBox::setRequired()| Name | Type | Description |
|---|---|---|
| $flag | bool | Default value is true |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setSelector(string $selector) : \Zend_Dojo_Form_Element_NumberTextBoxSet numeric format Selector
Inherited from: \Zend_Dojo_Form_Element_DateTextBox::setSelector()| Name | Type | Description |
|---|---|---|
| $selector | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_NumberTextBox |
- See
- \$_allowedSelectorTypes

setStrict( $flag) : \Zend_Dojo_Form_Element_DateTextBox| Name | Type | Description |
|---|---|---|
| $flag |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_DateTextBox |

setTimePattern(string $pattern) : \Zend_Dojo_Form_Element_NumberTextBoxSet time format pattern
| Name | Type | Description |
|---|---|---|
| $pattern | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_NumberTextBox |

setTranslator(\Zend_Translate | null $translator = null) : \Zend_Form_ElementSet translator object for localization
Inherited from: \Zend_Form_Element::setTranslator()\Zend_Dojo_Form_Element_Dijit::setTranslator()\Zend_Dojo_Form_Element_TextBox::setTranslator()\Zend_Dojo_Form_Element_ValidationTextBox::setTranslator()\Zend_Dojo_Form_Element_DateTextBox::setTranslator()| Name | Type | Description |
|---|---|---|
| $translator | \Zend_Translate | null |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setTrim( $flag) : \Zend_Dojo_Form_Element_TextBoxSet trim flag
Inherited from: \Zend_Dojo_Form_Element_TextBox::setTrim()\Zend_Dojo_Form_Element_ValidationTextBox::setTrim()\Zend_Dojo_Form_Element_DateTextBox::setTrim()| Name | Type | Description |
|---|---|---|
| $flag |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_TextBox |

setUppercase( $flag) : \Zend_Dojo_Form_Element_TextBoxSet uppercase flag
Inherited from: \Zend_Dojo_Form_Element_TextBox::setUppercase()\Zend_Dojo_Form_Element_ValidationTextBox::setUppercase()\Zend_Dojo_Form_Element_DateTextBox::setUppercase()| Name | Type | Description |
|---|---|---|
| $flag |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_TextBox |

setValidators(array $validators) : \Zend_Form_ElementSet multiple validators, overwriting previous validators
Inherited from: \Zend_Form_Element::setValidators()\Zend_Dojo_Form_Element_Dijit::setValidators()\Zend_Dojo_Form_Element_TextBox::setValidators()\Zend_Dojo_Form_Element_ValidationTextBox::setValidators()\Zend_Dojo_Form_Element_DateTextBox::setValidators()| Name | Type | Description |
|---|---|---|
| $validators | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setValue(mixed $value) : \Zend_Form_ElementSet element value
Inherited from: \Zend_Form_Element::setValue()\Zend_Dojo_Form_Element_Dijit::setValue()\Zend_Dojo_Form_Element_TextBox::setValue()\Zend_Dojo_Form_Element_ValidationTextBox::setValue()\Zend_Dojo_Form_Element_DateTextBox::setValue()| Name | Type | Description |
|---|---|---|
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setView(\Zend_View_Interface $view = null) : \Zend_Dojo_Form_Element_DijitSet the view object
Inherited from: \Zend_Dojo_Form_Element_Dijit::setView()\Zend_Dojo_Form_Element_TextBox::setView()\Zend_Dojo_Form_Element_ValidationTextBox::setView()\Zend_Dojo_Form_Element_DateTextBox::setView()Ensures that the view object has the dojo view helper path set.
| Name | Type | Description |
|---|---|---|
| $view | \Zend_View_Interface |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_Dijit |

setVisibleIncrement(string $format) : \Zend_Dojo_Form_Element_NumberTextBoxSet visibleIncrement
| Name | Type | Description |
|---|---|---|
| $format | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_NumberTextBox |

setVisibleRange(string $format) : \Zend_Dojo_Form_Element_NumberTextBoxSet visibleRange
| Name | Type | Description |
|---|---|---|
| $format | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_NumberTextBox |

translatorIsDisabled() : boolIs translation disabled?
Inherited from: \Zend_Form_Element::translatorIsDisabled()\Zend_Dojo_Form_Element_Dijit::translatorIsDisabled()\Zend_Dojo_Form_Element_TextBox::translatorIsDisabled()\Zend_Dojo_Form_Element_ValidationTextBox::translatorIsDisabled()\Zend_Dojo_Form_Element_DateTextBox::translatorIsDisabled()| Type | Description |
|---|---|
| bool |