Dojo/Form/Element/FilteringSelect.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_FilteringSelect
Note: this would be easier with mixins or traits...
- Parent(s)
- \Zend_Dojo_Form_Element_ComboBox < \Zend_Dojo_Form_Element_DijitMulti < \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_ComboBox
- Version
- $Id: FilteringSelect.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_DijitMulti::DECORATOR
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::DECORATOR
FILTER
= 'FILTER'- Inherited_from
- \Zend_Form_Element::FILTER
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::FILTER
- Inherited_from
- \Zend_Dojo_Form_Element_DijitMulti::FILTER
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::FILTER
VALIDATE
= 'VALIDATE'- Inherited_from
- \Zend_Form_Element::VALIDATE
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::VALIDATE
- Inherited_from
- \Zend_Dojo_Form_Element_DijitMulti::VALIDATE
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::$$_allowEmpty
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_allowEmpty

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_DijitMulti::$$_autoInsertNotEmptyValidator
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_belongsTo
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_decorators
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_description
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_disableLoadDefaultDecorators
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_errorMessageSeparator
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_errorMessages
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_errors
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_filters
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_ignore
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_isArray
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_isError
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_isErrorForced
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_isPartialRendering
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_label
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_loaders
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_messages
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_name
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_order
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_order

bool $_registerInArrayValidator = truetrueDetails- Type
- bool

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_DijitMulti::$$_required
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_required

string $_separator = '<br />''.
'<br />'Details- Type
- string
- Inherited_from
- \Zend_Dojo_Form_Element_DijitMulti::$$_separator
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_separator

array $_translated = array()array()Details- Type
- array
- Inherited_from
- \Zend_Dojo_Form_Element_DijitMulti::$$_translated
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_translated

\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_DijitMulti::$$_translator
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_translatorDisabled
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_type
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_validatorRules
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_validators
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_value
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_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_DijitMulti::$$_view
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$_view

array $dijitParams = array()array()Details- Type
- array
- Inherited_from
- \Zend_Dojo_Form_Element_Dijit::$$dijitParams
- Inherited_from
- \Zend_Dojo_Form_Element_DijitMulti::$$dijitParams
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$dijitParams

string $helper = 'FilteringSelect''FilteringSelect'Details- Type
- string

array $options = array()array()Details- Type
- array
- Inherited_from
- \Zend_Dojo_Form_Element_DijitMulti::$$options
- Inherited_from
- \Zend_Dojo_Form_Element_ComboBox::$$options
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_DijitMulti::__call()\Zend_Dojo_Form_Element_ComboBox::__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_DijitMulti::__construct()\Zend_Dojo_Form_Element_ComboBox::__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_DijitMulti::__get()\Zend_Dojo_Form_Element_ComboBox::__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_DijitMulti::__set()\Zend_Dojo_Form_Element_ComboBox::__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_DijitMulti::__toString()\Zend_Dojo_Form_Element_ComboBox::__toString()Proxies to render().
| Type | Description |
|---|---|
| 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_DijitMulti::_filterValue()\Zend_Dojo_Form_Element_ComboBox::_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_DijitMulti::_getDecorator()\Zend_Dojo_Form_Element_ComboBox::_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_DijitMulti::_getErrorMessages()\Zend_Dojo_Form_Element_ComboBox::_getErrorMessages()| Type | Description |
|---|---|
| array |

_getMultiOptions() : arrayRetrieve options array
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::_getMultiOptions()\Zend_Dojo_Form_Element_ComboBox::_getMultiOptions()| 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_DijitMulti::_hasErrorMessages()\Zend_Dojo_Form_Element_ComboBox::_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_DijitMulti::_loadDecorator()\Zend_Dojo_Form_Element_ComboBox::_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_DijitMulti::_loadFilter()\Zend_Dojo_Form_Element_ComboBox::_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_DijitMulti::_loadValidator()\Zend_Dojo_Form_Element_ComboBox::_loadValidator()| Name | Type | Description |
|---|---|---|
| $validator | array | Validator definition |
| Type | Description |
|---|---|
| \Zend_Validate_Interface |

_translateOption(string $option, string $value) : boolTranslate an option
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::_translateOption()\Zend_Dojo_Form_Element_ComboBox::_translateOption()| Name | Type | Description |
|---|---|---|
| $option | string | |
| $value | string |
| Type | Description |
|---|---|
| bool |

_translateValue(array | string $value) : array | stringTranslate a value
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::_translateValue()\Zend_Dojo_Form_Element_ComboBox::_translateValue()| Name | Type | Description |
|---|---|---|
| $value | array | string |
| Type | Description |
|---|---|
| array | string |

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_DijitMulti::addDecorator()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addDecorators()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addError()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addErrorMessage()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addErrorMessages()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addErrors()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addFilter()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addFilters()\Zend_Dojo_Form_Element_ComboBox::addFilters()| Name | Type | Description |
|---|---|---|
| $filters | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addMultiOption(string $option, string $value = '') : \Zend_Form_Element_MultiAdd an option
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::addMultiOption()\Zend_Dojo_Form_Element_ComboBox::addMultiOption()| Name | Type | Description |
|---|---|---|
| $option | string | |
| $value | string |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |

addMultiOptions(array $options) : \Zend_Form_Element_MultiAdd many options at once
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::addMultiOptions()\Zend_Dojo_Form_Element_ComboBox::addMultiOptions()| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |

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_DijitMulti::addPrefixPath()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addPrefixPaths()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addValidator()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::addValidators()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::autoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_ComboBox::autoInsertNotEmptyValidator()| Type | Description |
|---|---|
| bool |

clearDecorators() : \Zend_Form_ElementClear all decorators
Inherited from: \Zend_Form_Element::clearDecorators()\Zend_Dojo_Form_Element_Dijit::clearDecorators()\Zend_Dojo_Form_Element_DijitMulti::clearDecorators()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::clearDijitParams()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::clearErrorMessages()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::clearFilters()\Zend_Dojo_Form_Element_ComboBox::clearFilters()| Type | Description |
|---|---|
| \Zend_Form_Element |

clearMultiOptions() : \Zend_Form_Element_MultiClear all options
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::clearMultiOptions()\Zend_Dojo_Form_Element_ComboBox::clearMultiOptions()| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |

clearValidators() : \Zend_Form_ElementClear all validators
Inherited from: \Zend_Form_Element::clearValidators()\Zend_Dojo_Form_Element_Dijit::clearValidators()\Zend_Dojo_Form_Element_DijitMulti::clearValidators()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::filterName()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getAllowEmpty()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getAttrib()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getAttribs()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getBelongsTo()\Zend_Dojo_Form_Element_ComboBox::getBelongsTo()| Type | Description |
|---|---|
| string |

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_DijitMulti::getDecorator()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getDecorators()\Zend_Dojo_Form_Element_ComboBox::getDecorators()| Type | Description |
|---|---|
| array |

getDescription() : stringRetrieve element description
Inherited from: \Zend_Form_Element::getDescription()\Zend_Dojo_Form_Element_Dijit::getDescription()\Zend_Dojo_Form_Element_DijitMulti::getDescription()\Zend_Dojo_Form_Element_ComboBox::getDescription()| Type | Description |
|---|---|
| string |

getDijitParam(string $key) : mixedGet a single dijit parameter
Inherited from: \Zend_Dojo_Form_Element_Dijit::getDijitParam()\Zend_Dojo_Form_Element_DijitMulti::getDijitParam()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getDijitParams()\Zend_Dojo_Form_Element_ComboBox::getDijitParams()| Type | Description |
|---|---|
| array |

getErrorMessageSeparator() : stringGet errorMessageSeparator
Inherited from: \Zend_Form_Element::getErrorMessageSeparator()\Zend_Dojo_Form_Element_Dijit::getErrorMessageSeparator()\Zend_Dojo_Form_Element_DijitMulti::getErrorMessageSeparator()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getErrorMessages()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getErrors()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getFilter()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getFilters()\Zend_Dojo_Form_Element_ComboBox::getFilters()| Type | Description |
|---|---|
| array |

getFullyQualifiedName() : stringGet fully qualified name
Inherited from: \Zend_Form_Element::getFullyQualifiedName()\Zend_Dojo_Form_Element_Dijit::getFullyQualifiedName()\Zend_Dojo_Form_Element_DijitMulti::getFullyQualifiedName()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getId()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getIgnore()\Zend_Dojo_Form_Element_ComboBox::getIgnore()| Type | Description |
|---|---|
| bool |

getLabel() : stringRetrieve element label
Inherited from: \Zend_Form_Element::getLabel()\Zend_Dojo_Form_Element_Dijit::getLabel()\Zend_Dojo_Form_Element_DijitMulti::getLabel()\Zend_Dojo_Form_Element_ComboBox::getLabel()| Type | Description |
|---|---|
| string |

getMessages() : arrayRetrieve error messages
Inherited from: \Zend_Form_Element::getMessages()\Zend_Dojo_Form_Element_Dijit::getMessages()\Zend_Dojo_Form_Element_DijitMulti::getMessages()\Zend_Dojo_Form_Element_ComboBox::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 |

getMultiOption(string $option) : mixedRetrieve single multi option
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::getMultiOption()\Zend_Dojo_Form_Element_ComboBox::getMultiOption()| Name | Type | Description |
|---|---|---|
| $option | string |
| Type | Description |
|---|---|
| mixed |

getMultiOptions() : arrayRetrieve options
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::getMultiOptions()\Zend_Dojo_Form_Element_ComboBox::getMultiOptions()| Type | Description |
|---|---|
| array |

getName() : stringReturn element name
Inherited from: \Zend_Form_Element::getName()\Zend_Dojo_Form_Element_Dijit::getName()\Zend_Dojo_Form_Element_DijitMulti::getName()\Zend_Dojo_Form_Element_ComboBox::getName()| Type | Description |
|---|---|
| string |

getOrder() : intRetrieve element order
Inherited from: \Zend_Form_Element::getOrder()\Zend_Dojo_Form_Element_Dijit::getOrder()\Zend_Dojo_Form_Element_DijitMulti::getOrder()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getPluginLoader()\Zend_Dojo_Form_Element_ComboBox::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. |

getSeparator() : mixedRetrieve separator
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::getSeparator()\Zend_Dojo_Form_Element_ComboBox::getSeparator()| Type | Description |
|---|---|
| mixed |

getTranslator() : \Zend_Translate_Adapter | nullRetrieve localization translator object
Inherited from: \Zend_Form_Element::getTranslator()\Zend_Dojo_Form_Element_Dijit::getTranslator()\Zend_Dojo_Form_Element_DijitMulti::getTranslator()\Zend_Dojo_Form_Element_ComboBox::getTranslator()| Type | Description |
|---|---|
| \Zend_Translate_Adapter | null |

getType() : stringReturn element type
Inherited from: \Zend_Form_Element::getType()\Zend_Dojo_Form_Element_Dijit::getType()\Zend_Dojo_Form_Element_DijitMulti::getType()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::getUnfilteredValue()\Zend_Dojo_Form_Element_ComboBox::getUnfilteredValue()| Type | Description |
|---|---|
| mixed |

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

hasDijitParam(string $key) : boolDoes the given dijit parameter exist?
Inherited from: \Zend_Dojo_Form_Element_Dijit::hasDijitParam()\Zend_Dojo_Form_Element_DijitMulti::hasDijitParam()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::hasErrors()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::hasTranslator()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::init()\Zend_Dojo_Form_Element_ComboBox::init()
isArray() : boolIs the element representing an array?
Inherited from: \Zend_Form_Element::isArray()\Zend_Dojo_Form_Element_Dijit::isArray()\Zend_Dojo_Form_Element_DijitMulti::isArray()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::isRequired()\Zend_Dojo_Form_Element_ComboBox::isRequired()| Type | Description |
|---|---|
| bool |

isValid(string $value, mixed $context = null) : boolAutoregisters InArray validator if necessary.
| Name | Type | Description |
|---|---|---|
| $value | string | |
| $context | mixed |
| Type | Description |
|---|---|
| bool |
| 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_DijitMulti::loadDefaultDecorators()\Zend_Dojo_Form_Element_ComboBox::loadDefaultDecorators()
loadDefaultDecoratorsIsDisabled() : boolShould we load the default decorators?
Inherited from: \Zend_Form_Element::loadDefaultDecoratorsIsDisabled()\Zend_Dojo_Form_Element_Dijit::loadDefaultDecoratorsIsDisabled()\Zend_Dojo_Form_Element_DijitMulti::loadDefaultDecoratorsIsDisabled()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::markAsError()\Zend_Dojo_Form_Element_ComboBox::markAsError()| Type | Description |
|---|---|
| \Zend_Form_Element |

registerInArrayValidator() : boolGet status of auto-register inArray validator flag
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::registerInArrayValidator()\Zend_Dojo_Form_Element_ComboBox::registerInArrayValidator()| Type | Description |
|---|---|
| bool |

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

removeMultiOption(string $option) : boolRemove a single multi option
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::removeMultiOption()\Zend_Dojo_Form_Element_ComboBox::removeMultiOption()| Name | Type | Description |
|---|---|---|
| $option | string |
| Type | Description |
|---|---|
| bool |

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_DijitMulti::removeValidator()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::render()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::resolveElementId()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setAllowEmpty()\Zend_Dojo_Form_Element_ComboBox::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_ElementSet element attribute
Inherited from: \Zend_Form_Element::setAttrib()\Zend_Dojo_Form_Element_Dijit::setAttrib()\Zend_Dojo_Form_Element_DijitMulti::setAttrib()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setAttribs()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setAutoInsertNotEmptyValidator()\Zend_Dojo_Form_Element_ComboBox::setAutoInsertNotEmptyValidator()| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setAutocomplete(bool $flag) : \Zend_Dojo_Form_Element_ComboBox| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ComboBox |

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

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

setDecorators(array $decorators) : \Zend_Form_ElementOverwrite all decorators
Inherited from: \Zend_Form_Element::setDecorators()\Zend_Dojo_Form_Element_Dijit::setDecorators()\Zend_Dojo_Form_Element_DijitMulti::setDecorators()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setDescription()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setDijitParam()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setDijitParams()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setDisableLoadDefaultDecorators()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setDisableTranslator()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setErrorMessageSeparator()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setErrorMessages()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setErrors()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setFilters()\Zend_Dojo_Form_Element_ComboBox::setFilters()| Name | Type | Description |
|---|---|---|
| $filters | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

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

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

setMultiOptions(array $options) : \Zend_Form_Element_MultiSet all options at once (overwrites)
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::setMultiOptions()\Zend_Dojo_Form_Element_ComboBox::setMultiOptions()| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |

setName(string $name) : \Zend_Form_ElementSet element name
Inherited from: \Zend_Form_Element::setName()\Zend_Dojo_Form_Element_Dijit::setName()\Zend_Dojo_Form_Element_DijitMulti::setName()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setOptions()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setOrder()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setPluginLoader()\Zend_Dojo_Form_Element_ComboBox::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 |

setRegisterInArrayValidator(bool $flag) : \Zend_Form_Element_MultiSet flag indicating whether or not to auto-register inArray validator
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::setRegisterInArrayValidator()\Zend_Dojo_Form_Element_ComboBox::setRegisterInArrayValidator()| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |

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

setSeparator(mixed $separator) : \Zend_Dojo_Form_Element_FilteringSelectSet separator
Inherited from: \Zend_Dojo_Form_Element_DijitMulti::setSeparator()\Zend_Dojo_Form_Element_ComboBox::setSeparator()| Name | Type | Description |
|---|---|---|
| $separator | mixed |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_FilteringSelect |
- Fluent
- This method is part of a fluent interface and will return the same instance

setStoreId(string $identifier) : \Zend_Dojo_Form_Element_ComboBox| Name | Type | Description |
|---|---|---|
| $identifier | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ComboBox |

setStoreParams(array $params) : \Zend_Dojo_Form_Element_ComboBox| Name | Type | Description |
|---|---|---|
| $params | array |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ComboBox |

setStoreType(string $dojoType) : \Zend_Dojo_Form_Element_ComboBox| Name | Type | Description |
|---|---|---|
| $dojoType | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_ComboBox |

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

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_DijitMulti::setValidators()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setValue()\Zend_Dojo_Form_Element_ComboBox::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_DijitMulti::setView()\Zend_Dojo_Form_Element_ComboBox::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() : boolIs translation disabled?
Inherited from: \Zend_Form_Element::translatorIsDisabled()\Zend_Dojo_Form_Element_Dijit::translatorIsDisabled()\Zend_Dojo_Form_Element_DijitMulti::translatorIsDisabled()\Zend_Dojo_Form_Element_ComboBox::translatorIsDisabled()| Type | Description |
|---|---|
| bool |