Dojo/Form/Element/NumberSpinner.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_NumberSpinner
- Parent(s)
- \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_ValidationTextBox
- Version
- $Id: NumberSpinner.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

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

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
Properties


bool $_allowEmpty = true
true
Details- 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


bool $_autoInsertNotEmptyValidator = true
true
Details- 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


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


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


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


bool $_disableLoadDefaultDecorators = false
false
Details- 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


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


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


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


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


bool $_ignore = false
false
Details- 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


bool $_isArray = false
false
Details- 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


bool $_isError = false
false
Details- 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


bool $_isErrorForced = false
false
Details- 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


bool $_isPartialRendering = false
This is to allow execution of logic inside the render() methods of child elements during the magic call while skipping the parent render() method.
false
Details- 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


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


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


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


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


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


bool $_required = false
false
Details- 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


\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


bool $_translatorDisabled = false
false
Details- 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


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


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


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


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


\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


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
Methods


__call(string $method, array $args) : string
Overloading: 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()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) : void
Constructor
Inherited from: \Zend_Dojo_Form_Element_Dijit::__construct()\Zend_Dojo_Form_Element_TextBox::__construct()\Zend_Dojo_Form_Element_ValidationTextBox::__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) : mixed
Overloading: 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()Prevents access to properties beginning with '_'.
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |


__set(string $key, mixed $value) : \voide
Overloading: 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()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\voide |


__toString() : string
String 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()Proxies to render().
Type | Description |
---|---|
string |


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


_filterValue(string $value, string $key) : void
Filter 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()Name | Type | Description |
---|---|---|
$value | string | |
$key | string |


_getDecorator(string $name, null | array $options) : \Zend_Form_Decorator_Interface
Instantiate 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()Name | Type | Description |
---|---|---|
$name | string | |
$options | null | array |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |


_getErrorMessages() : array
Retrieve 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()Type | Description |
---|---|
array |


_hasErrorMessages() : bool
Are 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()Type | Description |
---|---|
bool |


_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_Interface
Lazy-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()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_Interface
Lazy-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()Name | Type | Description |
---|---|---|
$filter | array |
Type | Description |
---|---|
\Zend_Filter_Interface |


_loadValidator(array $validator) : \Zend_Validate_Interface
Lazy-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()Name | Type | Description |
---|---|---|
$validator | array | Validator definition |
Type | Description |
---|---|
\Zend_Validate_Interface |


addDecorator(string | \Zend_Form_Decorator_Interface $decorator, array | \Zend_Config $options = null) : \Zend_Form_Element
Add 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()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_Element
Add 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()Name | Type | Description |
---|---|---|
$decorators | array |
Type | Description |
---|---|
\Zend_Form_Element |


addError(string $message) : \Zend_Form_Element
Add 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()Name | Type | Description |
---|---|---|
$message | string |
Type | Description |
---|---|
\Zend_Form_Element |


addErrorMessage(string $message) : \Zend_Form_Element
Add 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()Name | Type | Description |
---|---|---|
$message | string |
Type | Description |
---|---|
\Zend_Form_Element |


addErrorMessages(array $messages) : \Zend_Form_Element
Add 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()Name | Type | Description |
---|---|---|
$messages | array |
Type | Description |
---|---|
\Zend_Form_Element |


addErrors(array $messages) : \Zend_Form_Element
Add 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()Name | Type | Description |
---|---|---|
$messages | array |
Type | Description |
---|---|
\Zend_Form_Element |


addFilter(string | \Zend_Filter_Interface $filter, $options = array()) : \Zend_Form_Element
Add 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()Name | Type | Description |
---|---|---|
$filter | string | \Zend_Filter_Interface | |
$options |
Type | Description |
---|---|
\Zend_Form_Element |


addFilters(array $filters) : \Zend_Form_Element
Add 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()Name | Type | Description |
---|---|---|
$filters | array |
Type | Description |
---|---|
\Zend_Form_Element |


addPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form_Element
Add 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()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_Element
Add 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()Name | Type | Description |
---|---|---|
$spec | array |
Type | Description |
---|---|
\Zend_Form_Element |


addValidator(string | \Zend_Validate_Interface $validator, bool $breakChainOnFailure = false, array $options = array()) : \Zend_Form_Element
Add 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()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_Element
Add 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()Name | Type | Description |
---|---|---|
$validators | array |
Type | Description |
---|---|
\Zend_Form_Element |


autoInsertNotEmptyValidator() : bool
Get 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()Type | Description |
---|---|
bool |


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


clearDecorators() : \Zend_Form_Element
Clear 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()Type | Description |
---|---|
\Zend_Form_Element |


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


clearErrorMessages() : \Zend_Form_Element
Clear 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()Type | Description |
---|---|
\Zend_Form_Element |


clearFilters() : \Zend_Form_Element
Clear 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()Type | Description |
---|---|
\Zend_Form_Element |


clearValidators() : \Zend_Form_Element
Clear 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()Type | Description |
---|---|
\Zend_Form_Element |


filterName(string $value, bool $allowBrackets = false) : string
Filter 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()Name | Type | Description |
---|---|---|
$value | string | |
$allowBrackets | bool |
Type | Description |
---|---|
string |


getAllowEmpty() : bool
Get '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()Type | Description |
---|---|
bool |


getAttrib(string $name) : string
Retrieve 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()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string |


getAttribs() : array
Return 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()Type | Description |
---|---|
array |


getBelongsTo() : string
Return 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()Type | Description |
---|---|
string |


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


getDecorator(string $name) : false | \Zend_Form_Decorator_Abstract
Retrieve 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()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
false | \Zend_Form_Decorator_Abstract |


getDecorators() : array
Retrieve 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()Type | Description |
---|---|
array |


getDescription() : string
Retrieve 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()Type | Description |
---|---|
string |


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


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


getErrorMessageSeparator() : string
Get 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()Type | Description |
---|---|
string |


getErrorMessages() : array
Retrieve 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()Type | Description |
---|---|
array |


getErrors() : array
Retrieve 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()Type | Description |
---|---|
array |


getFilter(string $name) : \Zend_Filter_Interface
Retrieve 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()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Filter_Interface |


getFilters() : array
Get 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()Type | Description |
---|---|
array |


getFullyQualifiedName() : string
Get 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()Places name as subitem of array and/or appends brackets.
Type | Description |
---|---|
string |


getId() : string
Get 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()Type | Description |
---|---|
string |


getIgnore() : bool
Get 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()Type | Description |
---|---|
bool |


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


getLabel() : string
Retrieve 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()Type | Description |
---|---|
string |


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


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


getMessages() : array
Retrieve 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()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() : string
Return 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()Type | Description |
---|---|
string |


getOrder() : int
Retrieve 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()Type | Description |
---|---|
int |


getPluginLoader(string $type) : \Zend_Loader_PluginLoader
Retrieve 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()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 | null
Retrieve promptMessage
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::getPromptMessage()Type | Description |
---|---|
string | null |


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


getTranslator() : \Zend_Translate_Adapter | null
Retrieve 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()Type | Description |
---|---|
\Zend_Translate_Adapter | null |


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


getType() : string
Return 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()Type | Description |
---|---|
string |


getUnfilteredValue() : mixed
Retrieve 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()Type | Description |
---|---|
mixed |


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


getValidator(string $name) : \Zend_Validate_Interface | false
Retrieve 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()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Validate_Interface | false | False if not found, validator otherwise |


getValidators() : array
Retrieve 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()Type | Description |
---|---|
array |


getValue() : mixed
Retrieve 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()Type | Description |
---|---|
mixed |


getView() : null | \Zend_View_Interface
Retrieve 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()Retrieves from ViewRenderer if none previously set.
Type | Description |
---|---|
null | \Zend_View_Interface |


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


hasDijitParam(string $key) : bool
Does 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()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
bool |


hasErrors() : bool
Are 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()Type | Description |
---|---|
bool |


hasTranslator() : bool
Does 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()Type | Description |
---|---|
bool |


init() : void
Initialize 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()

isArray() : bool
Is 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()Type | Description |
---|---|
bool |


isRequired() : bool
Is 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()Type | Description |
---|---|
bool |


isValid(mixed $value, mixed $context = null) : boolean
Validate 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()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() : void
Load default decorators
Inherited from: \Zend_Dojo_Form_Element_Dijit::loadDefaultDecorators()\Zend_Dojo_Form_Element_TextBox::loadDefaultDecorators()\Zend_Dojo_Form_Element_ValidationTextBox::loadDefaultDecorators()

loadDefaultDecoratorsIsDisabled() : bool
Should 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()Type | Description |
---|---|
bool |


markAsError() : \Zend_Form_Element
Mark 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()Type | Description |
---|---|
\Zend_Form_Element |


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


removeDecorator(string $name) : \Zend_Form_Element
Remove 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()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Form_Element |


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


removeFilter(string $name) : \Zend_Form_Element
Remove 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()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Form_Element |


removeValidator(string $name) : bool
Remove 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()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
bool |


render(\Zend_View_Interface $view = null) : string
Render 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()Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
string |


resolveElementId(\Zend_Form_Decorator_Interface $decorator) : string
Used 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()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_Element
Set '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()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 |


setAttrib(string $name, mixed $value) : \Zend_Form_Element
Set 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()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_Element
Set 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()Name | Type | Description |
---|---|---|
$attribs | array |
Type | Description |
---|---|
\Zend_Form_Element |


setAutoInsertNotEmptyValidator(bool $flag) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Element |


setBelongsTo(string $array) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$array | string |
Type | Description |
---|---|
\Zend_Form_Element |


setConfig(\Zend_Config $config) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_Element |


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


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


setDecorators(array $decorators) : \Zend_Form_Element
Overwrite 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()Name | Type | Description |
---|---|---|
$decorators | array |
Type | Description |
---|---|
\Zend_Form_Element |


setDefaultTimeout(int $timeout) : \Zend_Dojo_Form_Element_NumberSpinner
Set defaultTimeout
Name | Type | Description |
---|---|---|
$timeout | int |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_NumberSpinner |


setDescription(string $description) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$description | string |
Type | Description |
---|---|
\Zend_Form_Element |


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


setDijitParams(array $params) : \Zend_Dojo_Form_Element_Dijit
Set 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()Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_Dijit |


setDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Element |


setDisableTranslator(bool $flag) : \Zend_Form_Element
Indicate 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()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Element |


setErrorMessageSeparator(string $separator) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$separator | string |
Type | Description |
---|---|
\Zend_Form_Element |


setErrorMessages(array $messages) : \Zend_Form_Element
Same 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()Name | Type | Description |
---|---|---|
$messages | array |
Type | Description |
---|---|
\Zend_Form_Element |


setErrors(array $messages) : \Zend_Form_Element
Overwrite 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()Name | Type | Description |
---|---|---|
$messages | array |
Type | Description |
---|---|
\Zend_Form_Element |


setFilters(array $filters) : \Zend_Form_Element
Add 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()Name | Type | Description |
---|---|---|
$filters | array |
Type | Description |
---|---|
\Zend_Form_Element |


setIgnore(bool $flag) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Element |


setIntermediateChanges(bool $flag) : \Zend_Dojo_Form_Element_TextBox
Set intermediateChanges flag
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_TextBox |


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


setIsArray(bool $flag) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Element |


setLabel(string $label) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$label | string |
Type | Description |
---|---|
\Zend_Form_Element |


setLargeDelta(int $delta) : \Zend_Dojo_Form_Element_NumberSpinner
Set largeDelta
Name | Type | Description |
---|---|---|
$delta | int |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_NumberSpinner |


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


setMax(int $value) : \Zend_Dojo_Form_Element_NumberSpinner
Set maximum value
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_NumberSpinner |


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


setMin(int $value) : \Zend_Dojo_Form_Element_NumberSpinner
Set minimum value
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_NumberSpinner |


setName(string $name) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Form_Element |


setOptions(array $options) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Form_Element |


setOrder(int $order) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$order | int |
Type | Description |
---|---|
\Zend_Form_Element |


setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type) : \Zend_Form_Element
Set 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()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_ValidationTextBox
Set promptMessage
Inherited from: \Zend_Dojo_Form_Element_ValidationTextBox::setPromptMessage()Name | Type | Description |
---|---|---|
$message | string |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_ValidationTextBox |


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


setRangeMessage(string $message) : \Zend_Dojo_Form_Element_NumberSpinner
Set rangeMessage
Name | Type | Description |
---|---|---|
$message | string |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_NumberSpinner |


setRegExp(string $regexp) : \Zend_Dojo_Form_Element_ValidationTextBox
Name | Type | Description |
---|---|---|
$regexp | string |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_ValidationTextBox |


setRequired(bool $flag = true) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$flag | bool | Default value is true |
Type | Description |
---|---|
\Zend_Form_Element |


setSmallDelta(int $delta) : \Zend_Dojo_Form_Element_NumberSpinner
Set smallDelta
Name | Type | Description |
---|---|---|
$delta | int |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_NumberSpinner |


setTimeoutChangeRate(int $rate) : \Zend_Dojo_Form_Element_NumberSpinner
Set timeoutChangeRate
Name | Type | Description |
---|---|---|
$rate | int |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_NumberSpinner |


setTranslator(\Zend_Translate | null $translator = null) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate | null |
Type | Description |
---|---|
\Zend_Form_Element |


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


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


setValidators(array $validators) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$validators | array |
Type | Description |
---|---|
\Zend_Form_Element |


setValue(mixed $value) : \Zend_Form_Element
Set 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()Name | Type | Description |
---|---|---|
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Element |


setView(\Zend_View_Interface $view = null) : \Zend_Dojo_Form_Element_Dijit
Set the view object
Inherited from: \Zend_Dojo_Form_Element_Dijit::setView()\Zend_Dojo_Form_Element_TextBox::setView()\Zend_Dojo_Form_Element_ValidationTextBox::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 |


translatorIsDisabled() : bool
Is 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()Type | Description |
---|---|
bool |