Dojo/Form/Element/Dijit.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_Dijit
- Parent(s)
- \Zend_Form_Element
- Children
- \Zend_Dojo_Form_Element_Editor
- \Zend_Dojo_Form_Element_SimpleTextarea
- \Zend_Dojo_Form_Element_TextBox
- \Zend_Dojo_Form_Element_Button
- \Zend_Dojo_Form_Element_DijitMulti
- \Zend_Dojo_Form_Element_CheckBox
- \Zend_Dojo_Form_Element_Slider
- \Zend_Dojo_Form_Element_Textarea
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: Dijit.php 24593 2012-01-05 20:35:02Z matthew $
Constants
FILTER
= 'FILTER'- Inherited_from
- \Zend_Form_Element::FILTER
VALIDATE
= 'VALIDATE'- Inherited_from
- \Zend_Form_Element::VALIDATE
Properties

bool $_allowEmpty = truetrueDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_allowEmpty

bool $_autoInsertNotEmptyValidator = truetrueDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_autoInsertNotEmptyValidator

array $_decorators = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_decorators

bool $_disableLoadDefaultDecorators = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_disableLoadDefaultDecorators

string $_errorMessageSeparator = '; ''; 'Details- Type
- string
- Inherited_from
- \Zend_Form_Element::$$_errorMessageSeparator

array $_errorMessages = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_errorMessages

array $_errors = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_errors

array $_filters = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_filters

bool $_ignore = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_ignore

bool $_isErrorForced = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_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

array $_loaders = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_loaders

array $_messages = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_messages

bool $_required = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_required

\Zend_Translate $_translator- Type
- \Zend_Translate
- Inherited_from
- \Zend_Form_Element::$$_translator

bool $_translatorDisabled = falsefalseDetails- Type
- bool
- Inherited_from
- \Zend_Form_Element::$$_translatorDisabled

array $_validatorRules = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_validatorRules

array $_validators = array()array()Details- Type
- array
- Inherited_from
- \Zend_Form_Element::$$_validators

\Zend_View_Interface $_view- Type
- \Zend_View_Interface
- Inherited_from
- \Zend_Form_Element::$$_view
Methods

__call(string $method, array $args) : stringOverloading: allow rendering specific decorators
Inherited from: \Zend_Form_Element::__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
$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 |
- Todo
- Should we set dojo view helper paths here?

__get(string $key) : mixedPrevents access to properties beginning with '_'.
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |

__set(string $key, mixed $value) : \voide| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \voide |

_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()| 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()| Type | Description |
|---|---|
| array |

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

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

_loadValidator(array $validator) : \Zend_Validate_Interface| 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_ElementAdd a decorator for rendering the element
Inherited from: \Zend_Form_Element::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| 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()| 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()| 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()| 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()| Name | Type | Description |
|---|---|---|
| $messages | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addFilter(string | \Zend_Filter_Interface $filter, $options = array()) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $filter | string | \Zend_Filter_Interface | |
| $options |
| Type | Description |
|---|---|
| \Zend_Form_Element |

addFilters(array $filters) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $filters | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

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

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

clearDijitParams() : \Zend_Dojo_Form_Element_DijitClear all dijit parameters
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_Dijit |

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

getAttrib(string $name) : string| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| string |

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

getDecorator(string $name) : false | \Zend_Form_Decorator_Abstract| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| false | \Zend_Form_Decorator_Abstract |

getDijitParam(string $key) : mixedGet a single dijit parameter
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |

getFilter(string $name) : \Zend_Filter_Interface| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Filter_Interface |

getFullyQualifiedName() : stringPlaces name as subitem of array and/or appends brackets.
| Type | Description |
|---|---|
| string |

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

getMessages() : arrayThe 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 |

getPluginLoader(string $type) : \Zend_Loader_PluginLoaderRetrieve plugin loader for validator or filter chain
Inherited from: \Zend_Form_Element::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. |

getTranslator() : \Zend_Translate_Adapter | null| Type | Description |
|---|---|
| \Zend_Translate_Adapter | null |

getValidator(string $name) : \Zend_Validate_Interface | false| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Validate_Interface | false | False if not found, validator otherwise |

getView() : null | \Zend_View_InterfaceRetrieves from ViewRenderer if none previously set.
| Type | Description |
|---|---|
| null | \Zend_View_Interface |

hasDijitParam(string $key) : boolDoes the given dijit parameter exist?
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| bool |

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

isValid(mixed $value, mixed $context = null) : booleanIf 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 |

loadDefaultDecoratorsIsDisabled() : boolShould we load the default decorators?
Inherited from: \Zend_Form_Element::loadDefaultDecoratorsIsDisabled()| Type | Description |
|---|---|
| bool |

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

removeDecorator(string $name) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

removeDijitParam(string $key) : \Zend_Dojo_Form_Element_DijitRemove a single dijit parameter
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Element_Dijit |

removeFilter(string $name) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

removeValidator(string $name) : bool| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| bool |

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

setBelongsTo(string $array) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $array | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setConfig(\Zend_Config $config) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setDecorators(array $decorators) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $decorators | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setDescription(string $description) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $description | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setDijitParam(string $key, mixed $value) : \Zend_Dojo_Form_Element_DijitSet a dijit parameter
| 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
| 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()| 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()| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element |

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

setLabel(string $label) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $label | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setName(string $name) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setOptions(array $options) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Element |

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

setRequired(bool $flag = true) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $flag | bool | Default value is true |
| Type | Description |
|---|---|
| \Zend_Form_Element |

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

setValue(mixed $value) : \Zend_Form_Element| Name | Type | Description |
|---|---|---|
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Form_Element |

setView(\Zend_View_Interface $view = null) : \Zend_Dojo_Form_Element_DijitSet the view object
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 |