Dojo/Form/Element/Editor.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

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  
Version
$Id: Editor.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Dojo_Form_Element_Editor

Package: Zend\Dojo\Form\Element
Editor dijit
Parent(s)
\Zend_Dojo_Form_Element_Dijit < \Zend_Form_Element
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Dojo_Form_Element_Dijit  
Version
$Id: Dijit.php 24593 2012-01-05 20:35:02Z matthew $  

Constants

>VConstant  DECORATOR = 'DECORATOR'

Properties

>VPropertyprotectedbool $_allowEmpty = true
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_allowEmpty  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_allowEmpty  
>VPropertyprotectedbool $_autoInsertNotEmptyValidator = true
inherited
Flag indicating whether or not to insert NotEmpty validator when element is required
Inherited from: \Zend_Form_Element::$$_autoInsertNotEmptyValidator\Zend_Dojo_Form_Element_Dijit::$$_autoInsertNotEmptyValidator
>VPropertyprotectedstring $_belongsTo
inherited
Array to which element belongs
Inherited from: \Zend_Form_Element::$$_belongsTo\Zend_Dojo_Form_Element_Dijit::$$_belongsTo
Details
Type
string
Inherited_from
\Zend_Form_Element::$$_belongsTo  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_belongsTo  
>VPropertyprotectedarray $_decorators = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_decorators  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_decorators  
>VPropertyprotectedstring $_description
Details
Type
string
Inherited_from
\Zend_Form_Element::$$_description  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_description  
>VPropertyprotectedbool $_disableLoadDefaultDecorators = false
>VPropertyprotectedstring $_errorMessageSeparator = '; '
inherited
Separator to use when concatenating aggregate error messages (for elements having array values)
Inherited from: \Zend_Form_Element::$$_errorMessageSeparator\Zend_Dojo_Form_Element_Dijit::$$_errorMessageSeparator
Default value'; 'Details
Type
string
Inherited_from
\Zend_Form_Element::$$_errorMessageSeparator  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_errorMessageSeparator  
>VPropertyprotectedarray $_errorMessages = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_errorMessages  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_errorMessages  
>VPropertyprotectedarray $_errors = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_errors  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_errors  
>VPropertyprotectedarray $_filters = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_filters  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_filters  
>VPropertyprotectedbool $_ignore = false
inherited
Ignore flag (used when retrieving values at form level)
Inherited from: \Zend_Form_Element::$$_ignore\Zend_Dojo_Form_Element_Dijit::$$_ignore
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_ignore  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_ignore  
>VPropertyprotectedbool $_isArray = false
inherited
Does the element represent an array?
Inherited from: \Zend_Form_Element::$$_isArray\Zend_Dojo_Form_Element_Dijit::$$_isArray
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isArray  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isArray  
>VPropertyprotectedbool $_isError = false
inherited
Is the error marked as in an invalid state?
Inherited from: \Zend_Form_Element::$$_isError\Zend_Dojo_Form_Element_Dijit::$$_isError
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isError  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isError  
>VPropertyprotectedbool $_isErrorForced = false
inherited
Has the element been manually marked as invalid?
Inherited from: \Zend_Form_Element::$$_isErrorForced\Zend_Dojo_Form_Element_Dijit::$$_isErrorForced
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isErrorForced  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isErrorForced  
>VPropertyprotectedbool $_isPartialRendering = false
inherited
Is a specific decorator being rendered via the magic renderDecorator()?
Inherited from: \Zend_Form_Element::$$_isPartialRendering\Zend_Dojo_Form_Element_Dijit::$$_isPartialRendering

This is to allow execution of logic inside the render() methods of child elements during the magic call while skipping the parent render() method.

Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isPartialRendering  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isPartialRendering  
>VPropertyprotectedstring $_label
Details
Type
string
Inherited_from
\Zend_Form_Element::$$_label  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_label  
>VPropertyprotectedarray $_loaders = array()
inherited
Plugin loaders for filter and validator chains
Inherited from: \Zend_Form_Element::$$_loaders\Zend_Dojo_Form_Element_Dijit::$$_loaders
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_loaders  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_loaders  
>VPropertyprotectedarray $_messages = array()
inherited
Formatted validation error messages
Inherited from: \Zend_Form_Element::$$_messages\Zend_Dojo_Form_Element_Dijit::$$_messages
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_messages  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_messages  
>VPropertyprotectedstring $_name
Details
Type
string
Inherited_from
\Zend_Form_Element::$$_name  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_name  
>VPropertyprotectedint $_order
Details
Type
int
Inherited_from
\Zend_Form_Element::$$_order  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_order  
>VPropertyprotectedbool $_required = false
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_required  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_required  
>VPropertyprotectedbool $_translatorDisabled = false
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_translatorDisabled  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_translatorDisabled  
>VPropertyprotectedstring $_type
Details
Type
string
Inherited_from
\Zend_Form_Element::$$_type  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_type  
>VPropertyprotectedarray $_validatorRules = array()
inherited
Array of un-initialized validators
Inherited from: \Zend_Form_Element::$$_validatorRules\Zend_Dojo_Form_Element_Dijit::$$_validatorRules
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_validatorRules  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_validatorRules  
>VPropertyprotectedarray $_validators = array()
inherited
Array of initialized validators
Inherited from: \Zend_Form_Element::$$_validators\Zend_Dojo_Form_Element_Dijit::$$_validators
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_validators  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_validators  
>VPropertyprotectedmixed $_value
Details
Type
mixed
Inherited_from
\Zend_Form_Element::$$_value  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_value  
>VPropertyprotected\Zend_View_Interface $_view
>VPropertypublicarray $dijitParams = array()
inherited
Dijit parameters
Inherited from: \Zend_Dojo_Form_Element_Dijit::$$dijitParams
Default valuearray()Details
Type
array
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$dijitParams  
>VPropertypublicstring $helper = 'Editor'
View helper to use
Default value'Editor'Details
Type
string

Methods

methodpublic__call(string $method, array $args) : string
inherited

Overloading: allow rendering specific decorators

Inherited from: \Zend_Form_Element::__call()\Zend_Dojo_Form_Element_Dijit::__call()

Call renderDecoratorName() to render a specific decorator.

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid decorator or invalid method call
methodpublic__construct(mixed $spec, mixed $options = null) : void
inherited

Constructor

Inherited from: \Zend_Dojo_Form_Element_Dijit::__construct()

$spec may be: - string: name of element - array: options with which to configure element - Zend_Config: Zend_Config with options for configuring element

Parameters
NameTypeDescription
$specmixed
$optionsmixed
Throws
ExceptionDescription
\Zend_Form_Exceptionif no element name after initialization
methodpublic__get(string $key) : mixed
inherited

Overloading: retrieve object property

Inherited from: \Zend_Form_Element::__get()\Zend_Dojo_Form_Element_Dijit::__get()

Prevents access to properties beginning with '_'.

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublic__set(string $key, mixed $value) : \voide
inherited

Overloading: set object property

Inherited from: \Zend_Form_Element::__set()\Zend_Dojo_Form_Element_Dijit::__set()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\voide
methodpublic__toString() : string
inherited

String representation of form element

Inherited from: \Zend_Form_Element::__toString()\Zend_Dojo_Form_Element_Dijit::__toString()

Proxies to render().

Returns
TypeDescription
string
methodprotected_filterValue(string $value, string $key) : void
Parameters
NameTypeDescription
$valuestring
$keystring
methodprotected_getDecorator(string $name, null | array $options) : \Zend_Form_Decorator_Interface
inherited

Instantiate a decorator based on class name or class name fragment

Inherited from: \Zend_Form_Element::_getDecorator()\Zend_Dojo_Form_Element_Dijit::_getDecorator()
Parameters
NameTypeDescription
$namestring
$optionsnull | array
Returns
TypeDescription
\Zend_Form_Decorator_Interface
methodprotected_getErrorMessages() : array
inherited

Retrieve error messages and perform translation and value substitution

Inherited from: \Zend_Form_Element::_getErrorMessages()\Zend_Dojo_Form_Element_Dijit::_getErrorMessages()
Returns
TypeDescription
array
methodprotected_hasErrorMessages() : bool
inherited

Are there custom error messages registered?

Inherited from: \Zend_Form_Element::_hasErrorMessages()\Zend_Dojo_Form_Element_Dijit::_hasErrorMessages()
Returns
TypeDescription
bool
methodprotected_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_Interface
Parameters
NameTypeDescription
$decoratorarray

Decorator type and options

$namemixed

Decorator name or alias

Returns
TypeDescription
\Zend_Form_Decorator_Interface
methodprotected_loadFilter(array $filter) : \Zend_Filter_Interface
Parameters
NameTypeDescription
$filterarray
Returns
TypeDescription
\Zend_Filter_Interface
methodprotected_loadValidator(array $validator) : \Zend_Validate_Interface
Parameters
NameTypeDescription
$validatorarray

Validator definition

Returns
TypeDescription
\Zend_Validate_Interface
methodpublicaddCaptureEvent(string $event) : \Zend_Dojo_Form_Element_Editor

Add a single event to connect to the editing area

Parameters
NameTypeDescription
$eventstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddCaptureEvents(array $events) : \Zend_Dojo_Form_Element_Editor

Add multiple capture events

Parameters
NameTypeDescription
$eventsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddDecorator(string | \Zend_Form_Decorator_Interface $decorator, array | \Zend_Config $options = null) : \Zend_Form_Element
inherited

Add a decorator for rendering the element

Inherited from: \Zend_Form_Element::addDecorator()\Zend_Dojo_Form_Element_Dijit::addDecorator()
Parameters
NameTypeDescription
$decoratorstring | \Zend_Form_Decorator_Interface
$optionsarray | \Zend_Config

Options with which to initialize decorator

Returns
TypeDescription
\Zend_Form_Element
methodpublicaddDecorators(array $decorators) : \Zend_Form_Element
Parameters
NameTypeDescription
$decoratorsarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddError(string $message) : \Zend_Form_Element
inherited

Add an error message and mark element as failed validation

Inherited from: \Zend_Form_Element::addError()\Zend_Dojo_Form_Element_Dijit::addError()
Parameters
NameTypeDescription
$messagestring
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddErrorMessage(string $message) : \Zend_Form_Element
inherited

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()
Parameters
NameTypeDescription
$messagestring
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddErrorMessages(array $messages) : \Zend_Form_Element
inherited

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()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddErrors(array $messages) : \Zend_Form_Element
inherited

Add multiple error messages and flag element as failed validation

Inherited from: \Zend_Form_Element::addErrors()\Zend_Dojo_Form_Element_Dijit::addErrors()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddEvent(string $event) : \Zend_Dojo_Form_Element_Editor

Add a single event to the dijit

Parameters
NameTypeDescription
$eventstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddEvents(array $events) : \Zend_Dojo_Form_Element_Editor

Add multiple events

Parameters
NameTypeDescription
$eventsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddExtraPlugin(string $plugin) : \Zend_Dojo_Form_Element_Editor

Add a single editor extra plugin.

Parameters
NameTypeDescription
$pluginstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddExtraPlugins( $plugins) : \Zend_Dojo_Form_Element_Editor

Add multiple extra plugins.

Parameters
NameTypeDescription
$plugins
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddFilter(string | \Zend_Filter_Interface $filter,  $options = array()) : \Zend_Form_Element
inherited

Add a filter to the element

Inherited from: \Zend_Form_Element::addFilter()\Zend_Dojo_Form_Element_Dijit::addFilter()
Parameters
NameTypeDescription
$filterstring | \Zend_Filter_Interface
$options
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddFilters(array $filters) : \Zend_Form_Element
Parameters
NameTypeDescription
$filtersarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddPlugin(string $plugin) : \Zend_Dojo_Form_Element_Editor

Add a single editor plugin

Parameters
NameTypeDescription
$pluginstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddPlugins(array $plugins) : \Zend_Dojo_Form_Element_Editor

Add multiple plugins

Parameters
NameTypeDescription
$pluginsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form_Element
inherited

Add prefix path for plugin loader

Inherited from: \Zend_Form_Element::addPrefixPath()\Zend_Dojo_Form_Element_Dijit::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.

Parameters
NameTypeDescription
$prefixstring
$pathstring
$typestring
Returns
TypeDescription
\Zend_Form_Element
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid type
methodpublicaddPrefixPaths(array $spec) : \Zend_Form_Element
Parameters
NameTypeDescription
$specarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddStyleSheet(string $styleSheet) : \Zend_Dojo_Form_Element_Editor

Add a custom stylesheet

Parameters
NameTypeDescription
$styleSheetstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddStyleSheets(array $styleSheets) : \Zend_Dojo_Form_Element_Editor

Add multiple custom stylesheets

Parameters
NameTypeDescription
$styleSheetsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicaddValidator(string | \Zend_Validate_Interface $validator, bool $breakChainOnFailure = false, array $options = array()) : \Zend_Form_Element
inherited

Add validator to validation chain

Inherited from: \Zend_Form_Element::addValidator()\Zend_Dojo_Form_Element_Dijit::addValidator()

Note: will overwrite existing validators if they are of the same class.

Parameters
NameTypeDescription
$validatorstring | \Zend_Validate_Interface
$breakChainOnFailurebool
$optionsarray
Returns
TypeDescription
\Zend_Form_Element
Throws
ExceptionDescription
\Zend_Form_Exceptionif invalid validator type
methodpublicaddValidators(array $validators) : \Zend_Form_Element
Parameters
NameTypeDescription
$validatorsarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicautoInsertNotEmptyValidator() : bool
inherited

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()
Returns
TypeDescription
bool
methodpublicclearCaptureEvents() : \Zend_Dojo_Form_Element_Editor

Clear all capture events

Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicclearDecorators() : \Zend_Form_Element
Returns
TypeDescription
\Zend_Form_Element
methodpublicclearDijitParams() : \Zend_Dojo_Form_Element_Dijit
inherited

Clear all dijit parameters

Inherited from: \Zend_Dojo_Form_Element_Dijit::clearDijitParams()
Returns
TypeDescription
\Zend_Dojo_Form_Element_Dijit
methodpublicclearErrorMessages() : \Zend_Form_Element
Returns
TypeDescription
\Zend_Form_Element
methodpublicclearEvents() : \Zend_Dojo_Form_Element_Editor

Clear all events

Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicclearExtraPlugins() : \Zend_Dojo_Form_Element_Editor

Clear all extra plugins.

Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicclearFilters() : \Zend_Form_Element
Returns
TypeDescription
\Zend_Form_Element
methodpublicclearPlugins() : \Zend_Dojo_Form_Element_Editor

Clear all plugins

Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicclearStyleSheets() : \Zend_Dojo_Form_Element_Editor

Clear all stylesheets

Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicclearValidators() : \Zend_Form_Element
Returns
TypeDescription
\Zend_Form_Element
methodpublicfilterName(string $value, bool $allowBrackets = false) : string
inherited

Filter a name to only allow valid variable characters

Inherited from: \Zend_Form_Element::filterName()\Zend_Dojo_Form_Element_Dijit::filterName()
Parameters
NameTypeDescription
$valuestring
$allowBracketsbool
Returns
TypeDescription
string
methodpublicgetAllowEmpty() : bool
Returns
TypeDescription
bool
methodpublicgetAttrib(string $name) : string
inherited

Retrieve element attribute

Inherited from: \Zend_Form_Element::getAttrib()\Zend_Dojo_Form_Element_Dijit::getAttrib()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
string
methodpublicgetAttribs() : array
Returns
TypeDescription
array
methodpublicgetBelongsTo() : string
inherited

Return array name to which element belongs

Inherited from: \Zend_Form_Element::getBelongsTo()\Zend_Dojo_Form_Element_Dijit::getBelongsTo()
Returns
TypeDescription
string
methodpublicgetCaptureEvents() : array

Get all capture events

Returns
TypeDescription
array
methodpublicgetDecorator(string $name) : false | \Zend_Form_Decorator_Abstract
inherited

Retrieve a registered decorator

Inherited from: \Zend_Form_Element::getDecorator()\Zend_Dojo_Form_Element_Dijit::getDecorator()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
false | \Zend_Form_Decorator_Abstract
methodpublicgetDecorators() : array
Returns
TypeDescription
array
methodpublicgetDescription() : string
Returns
TypeDescription
string
methodpublicgetDijitParam(string $key) : mixed
inherited

Get a single dijit parameter

Inherited from: \Zend_Dojo_Form_Element_Dijit::getDijitParam()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetDijitParams() : array
inherited

Retrieve all dijit parameters

Inherited from: \Zend_Dojo_Form_Element_Dijit::getDijitParams()
Returns
TypeDescription
array
methodpublicgetEditActionInterval() : int

Get edit action interval; defaults to 3

Returns
TypeDescription
int
methodpublicgetErrorMessageSeparator() : string
Returns
TypeDescription
string
methodpublicgetErrorMessages() : array
Returns
TypeDescription
array
methodpublicgetErrors() : array
inherited

Retrieve validator chain errors

Inherited from: \Zend_Form_Element::getErrors()\Zend_Dojo_Form_Element_Dijit::getErrors()
Returns
TypeDescription
array
methodpublicgetEvents() : array

Get all events

Returns
TypeDescription
array
methodpublicgetExtraPlugins() : array

Get all extra plugins.

Returns
TypeDescription
array
methodpublicgetFilter(string $name) : \Zend_Filter_Interface
inherited

Retrieve a single filter by name

Inherited from: \Zend_Form_Element::getFilter()\Zend_Dojo_Form_Element_Dijit::getFilter()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Filter_Interface
methodpublicgetFilters() : array
Returns
TypeDescription
array
methodpublicgetFocusOnLoad() : bool

Retrieve focus on load flag

Returns
TypeDescription
bool
methodpublicgetFullyQualifiedName() : string

Places name as subitem of array and/or appends brackets.

Returns
TypeDescription
string
methodpublicgetHeight() : string

Retrieve height

Returns
TypeDescription
string
methodpublicgetId() : string
Returns
TypeDescription
string
methodpublicgetIgnore() : bool
inherited

Get ignore flag (used when retrieving values at form level)

Inherited from: \Zend_Form_Element::getIgnore()\Zend_Dojo_Form_Element_Dijit::getIgnore()
Returns
TypeDescription
bool
methodpublicgetInheritWidth() : bool

Whether or not to inherit the parent's width

Returns
TypeDescription
bool
methodpublicgetLabel() : string
Returns
TypeDescription
string
methodpublicgetMessages() : array

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.

Returns
TypeDescription
array
methodpublicgetMinHeight() : string

Get minimum height of editor

Returns
TypeDescription
string
methodpublicgetName() : string
Returns
TypeDescription
string
methodpublicgetOrder() : int
Returns
TypeDescription
int
methodpublicgetPluginLoader(string $type) : \Zend_Loader_PluginLoader
inherited

Retrieve plugin loader for validator or filter chain

Inherited from: \Zend_Form_Element::getPluginLoader()\Zend_Dojo_Form_Element_Dijit::getPluginLoader()

Instantiates with default rules if none available for that type. Use 'decorator', 'filter', or 'validate' for $type.

Parameters
NameTypeDescription
$typestring
Returns
TypeDescription
\Zend_Loader_PluginLoader
Throws
ExceptionDescription
\Zend_Loader_Exceptionon invalid type.
methodpublicgetPlugins() : array

Get all plugins

Returns
TypeDescription
array
methodpublicgetStyleSheets() : string

Get all stylesheets

Returns
TypeDescription
string
methodpublicgetTranslator() : \Zend_Translate_Adapter | null
inherited

Retrieve localization translator object

Inherited from: \Zend_Form_Element::getTranslator()\Zend_Dojo_Form_Element_Dijit::getTranslator()
Returns
TypeDescription
\Zend_Translate_Adapter | null
methodpublicgetType() : string
Returns
TypeDescription
string
methodpublicgetUnfilteredValue() : mixed
Returns
TypeDescription
mixed
methodpublicgetUpdateInterval() : int

Get update interval

Returns
TypeDescription
int
methodpublicgetValidator(string $name) : \Zend_Validate_Interface | false
inherited

Retrieve a single validator by name

Inherited from: \Zend_Form_Element::getValidator()\Zend_Dojo_Form_Element_Dijit::getValidator()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Validate_Interface | falseFalse if not found, validator otherwise
methodpublicgetValidators() : array
Returns
TypeDescription
array
methodpublicgetValue() : mixed
inherited

Retrieve filtered element value

Inherited from: \Zend_Form_Element::getValue()\Zend_Dojo_Form_Element_Dijit::getValue()
Returns
TypeDescription
mixed
methodpublicgetView() : null | \Zend_View_Interface

Retrieves from ViewRenderer if none previously set.

Returns
TypeDescription
null | \Zend_View_Interface
methodpublichasCaptureEvent(string $event) : bool

Is a given capture event registered?

Parameters
NameTypeDescription
$eventstring
Returns
TypeDescription
bool
methodpublichasDijitParam(string $key) : bool
inherited

Does the given dijit parameter exist?

Inherited from: \Zend_Dojo_Form_Element_Dijit::hasDijitParam()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
bool
methodpublichasErrors() : bool
inherited

Are there errors registered?

Inherited from: \Zend_Form_Element::hasErrors()\Zend_Dojo_Form_Element_Dijit::hasErrors()
Returns
TypeDescription
bool
methodpublichasEvent(string $event) : bool

Is a given event registered?

Parameters
NameTypeDescription
$eventstring
Returns
TypeDescription
bool
methodpublichasExtraPlugin(string $plugin) : bool

Is a given extra plugin registered?

Parameters
NameTypeDescription
$pluginstring
Returns
TypeDescription
bool
methodpublichasPlugin(string $plugin) : bool

Is a given plugin registered?

Parameters
NameTypeDescription
$pluginstring
Returns
TypeDescription
bool
methodpublichasStyleSheet(string $styleSheet) : bool

Is a given stylesheet registered?

Parameters
NameTypeDescription
$styleSheetstring
Returns
TypeDescription
bool
methodpublichasTranslator() : bool
inherited

Does this element have its own specific translator?

Inherited from: \Zend_Form_Element::hasTranslator()\Zend_Dojo_Form_Element_Dijit::hasTranslator()
Returns
TypeDescription
bool
methodpublicinit() : void
inherited

Initialize object; used by extending classes

Inherited from: \Zend_Form_Element::init()\Zend_Dojo_Form_Element_Dijit::init()
methodpublicisArray() : bool
inherited

Is the element representing an array?

Inherited from: \Zend_Form_Element::isArray()\Zend_Dojo_Form_Element_Dijit::isArray()
Returns
TypeDescription
bool
methodpublicisRequired() : bool
Returns
TypeDescription
bool
methodpublicisValid(mixed $value, mixed $context = null) : boolean
inherited

Validate element value

Inherited from: \Zend_Form_Element::isValid()\Zend_Dojo_Form_Element_Dijit::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.

Parameters
NameTypeDescription
$valuemixed
$contextmixed
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Validate_ExceptionIf validation of $value is impossible
methodpublicloadDefaultDecorators() : void
inherited

Load default decorators

Inherited from: \Zend_Dojo_Form_Element_Dijit::loadDefaultDecorators()
methodpublicloadDefaultDecoratorsIsDisabled() : bool
Returns
TypeDescription
bool
methodpublicmarkAsError() : \Zend_Form_Element
inherited

Mark the element as being in a failed validation state

Inherited from: \Zend_Form_Element::markAsError()\Zend_Dojo_Form_Element_Dijit::markAsError()
Returns
TypeDescription
\Zend_Form_Element
methodpublicremoveCaptureEvent(string $event) : \Zend_Dojo_Form_Element_Editor

Remove a given capture event

Parameters
NameTypeDescription
$eventstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicremoveDecorator(string $name) : \Zend_Form_Element
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form_Element
methodpublicremoveDijitParam(string $key) : \Zend_Dojo_Form_Element_Dijit
inherited

Remove a single dijit parameter

Inherited from: \Zend_Dojo_Form_Element_Dijit::removeDijitParam()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Dijit
methodpublicremoveEvent(string $event) : \Zend_Dojo_Form_Element_Editor

Remove a given event

Parameters
NameTypeDescription
$eventstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicremoveExtraPlugin(string $plugin) : \Zend_Dojo_Form_Element_Editor

Remove a given extra plugin.

Parameters
NameTypeDescription
$pluginstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicremoveFilter(string $name) : \Zend_Form_Element
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form_Element
methodpublicremovePlugin(string $plugin) : \Zend_Dojo_Form_Element_Editor

Remove a given plugin

Parameters
NameTypeDescription
$pluginstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicremoveStyleSheet(string $styleSheet) : \Zend_Dojo_Form_Element_Editor

Remove a single stylesheet

Parameters
NameTypeDescription
$styleSheetstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicremoveValidator(string $name) : bool
inherited

Remove a single validator by name

Inherited from: \Zend_Form_Element::removeValidator()\Zend_Dojo_Form_Element_Dijit::removeValidator()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
bool
methodpublicrender(\Zend_View_Interface $view = null) : string
Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
string
methodpublicresolveElementId(\Zend_Form_Decorator_Interface $decorator) : string
staticinherited

Used to resolve and return an element ID

Inherited from: \Zend_Form_Element::resolveElementId()\Zend_Dojo_Form_Element_Dijit::resolveElementId()

Passed to the HtmlTag decorator as a callback in order to provide an ID.

Parameters
NameTypeDescription
$decorator\Zend_Form_Decorator_Interface
Returns
TypeDescription
string
methodpublicsetAllowEmpty(bool $flag) : \Zend_Form_Element

When the allow empty flag is enabled and the required flag is false, the element will validate with empty values.

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetAttrib(string $name, mixed $value) : \Zend_Form_Element
Parameters
NameTypeDescription
$namestring
$valuemixed
Returns
TypeDescription
\Zend_Form_Element
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid $name values
methodpublicsetAttribs(array $attribs) : \Zend_Form_Element
inherited

Set multiple attributes at once

Inherited from: \Zend_Form_Element::setAttribs()\Zend_Dojo_Form_Element_Dijit::setAttribs()
Parameters
NameTypeDescription
$attribsarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetAutoInsertNotEmptyValidator(bool $flag) : \Zend_Form_Element
inherited

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()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetBelongsTo(string $array) : \Zend_Form_Element
inherited

Set array to which element belongs

Inherited from: \Zend_Form_Element::setBelongsTo()\Zend_Dojo_Form_Element_Dijit::setBelongsTo()
Parameters
NameTypeDescription
$arraystring
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetCaptureEvents(array $events) : \Zend_Dojo_Form_Element_Editor

Overwrite many capture events at once

Parameters
NameTypeDescription
$eventsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_Element
inherited

Set object state from Zend_Config object

Inherited from: \Zend_Form_Element::setConfig()\Zend_Dojo_Form_Element_Dijit::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetDecorators(array $decorators) : \Zend_Form_Element
Parameters
NameTypeDescription
$decoratorsarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetDescription(string $description) : \Zend_Form_Element
Parameters
NameTypeDescription
$descriptionstring
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetDijitParam(string $key, mixed $value) : \Zend_Dojo_Form_Element_Dijit
inherited

Set a dijit parameter

Inherited from: \Zend_Dojo_Form_Element_Dijit::setDijitParam()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Dojo_Form_Element_Dijit
methodpublicsetDijitParams(array $params) : \Zend_Dojo_Form_Element_Dijit
inherited

Set multiple dijit params at once

Inherited from: \Zend_Dojo_Form_Element_Dijit::setDijitParams()
Parameters
NameTypeDescription
$paramsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Dijit
methodpublicsetDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_Element
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetDisableTranslator(bool $flag) : \Zend_Form_Element
inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Form_Element::setDisableTranslator()\Zend_Dojo_Form_Element_Dijit::setDisableTranslator()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetEditActionInterval(int $interval) : \Zend_Dojo_Form_Element_Editor

Set edit action interval

Parameters
NameTypeDescription
$intervalint
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetErrorMessageSeparator(string $separator) : \Zend_Form_Element
Parameters
NameTypeDescription
$separatorstring
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetErrorMessages(array $messages) : \Zend_Form_Element
inherited

Same as addErrorMessages(), but clears custom error message stack first

Inherited from: \Zend_Form_Element::setErrorMessages()\Zend_Dojo_Form_Element_Dijit::setErrorMessages()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetErrors(array $messages) : \Zend_Form_Element
inherited

Overwrite any previously set error messages and flag as failed validation

Inherited from: \Zend_Form_Element::setErrors()\Zend_Dojo_Form_Element_Dijit::setErrors()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetEvents(array $events) : \Zend_Dojo_Form_Element_Editor

Overwrite many events at once

Parameters
NameTypeDescription
$eventsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetExtraPlugins(array $plugins) : \Zend_Dojo_Form_Element_Editor

Overwrite many extra plugins at once.

Parameters
NameTypeDescription
$pluginsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetFilters(array $filters) : \Zend_Form_Element
inherited

Add filters to element, overwriting any already existing

Inherited from: \Zend_Form_Element::setFilters()\Zend_Dojo_Form_Element_Dijit::setFilters()
Parameters
NameTypeDescription
$filtersarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetFocusOnLoad(bool $flag) : \Zend_Dojo_Form_Element_Editor

Set focus on load flag

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetHeight(string | int $height) : \Zend_Dojo_Form_Element_Editor

Set editor height

Parameters
NameTypeDescription
$heightstring | int
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetIgnore(bool $flag) : \Zend_Form_Element
inherited

Set ignore flag (used when retrieving values at form level)

Inherited from: \Zend_Form_Element::setIgnore()\Zend_Dojo_Form_Element_Dijit::setIgnore()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetInheritWidth(bool $flag) : \Zend_Dojo_Form_Element_Editor

Set whether or not to inherit parent's width

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetIsArray(bool $flag) : \Zend_Form_Element
inherited

Set flag indicating if element represents an array

Inherited from: \Zend_Form_Element::setIsArray()\Zend_Dojo_Form_Element_Dijit::setIsArray()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetLabel(string $label) : \Zend_Form_Element
Parameters
NameTypeDescription
$labelstring
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetMinHeight(string | int $minHeight) : \Zend_Dojo_Form_Element_Editor

Set minimum height of editor

Parameters
NameTypeDescription
$minHeightstring | int
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetName(string $name) : \Zend_Form_Element
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetOptions(array $options) : \Zend_Form_Element
inherited

Set object state from options array

Inherited from: \Zend_Form_Element::setOptions()\Zend_Dojo_Form_Element_Dijit::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetOrder(int $order) : \Zend_Form_Element
Parameters
NameTypeDescription
$orderint
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type) : \Zend_Form_Element
inherited

Set plugin loader to use for validator or filter chain

Inherited from: \Zend_Form_Element::setPluginLoader()\Zend_Dojo_Form_Element_Dijit::setPluginLoader()
Parameters
NameTypeDescription
$loader\Zend_Loader_PluginLoader_Interface
$typestring

'decorator', 'filter', or 'validate'

Returns
TypeDescription
\Zend_Form_Element
Throws
ExceptionDescription
\Zend_Form_Exceptionon invalid type
methodpublicsetPlugins(array $plugins) : \Zend_Dojo_Form_Element_Editor

Overwrite many plugins at once

Parameters
NameTypeDescription
$pluginsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetRequired(bool $flag = true) : \Zend_Form_Element
Parameters
NameTypeDescription
$flagbool

Default value is true

Returns
TypeDescription
\Zend_Form_Element
methodpublicsetStyleSheets(array $styleSheets) : \Zend_Dojo_Form_Element_Editor

Overwrite all stylesheets

Parameters
NameTypeDescription
$styleSheetsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetTranslator(\Zend_Translate | null $translator = null) : \Zend_Form_Element
inherited

Set translator object for localization

Inherited from: \Zend_Form_Element::setTranslator()\Zend_Dojo_Form_Element_Dijit::setTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | null
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetUpdateInterval(int $interval) : \Zend_Dojo_Form_Element_Editor

Set update interval

Parameters
NameTypeDescription
$intervalint
Returns
TypeDescription
\Zend_Dojo_Form_Element_Editor
methodpublicsetValidators(array $validators) : \Zend_Form_Element
inherited

Set multiple validators, overwriting previous validators

Inherited from: \Zend_Form_Element::setValidators()\Zend_Dojo_Form_Element_Dijit::setValidators()
Parameters
NameTypeDescription
$validatorsarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetValue(mixed $value) : \Zend_Form_Element
Parameters
NameTypeDescription
$valuemixed
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetView(\Zend_View_Interface $view = null) : \Zend_Dojo_Form_Element_Dijit
inherited

Set the view object

Inherited from: \Zend_Dojo_Form_Element_Dijit::setView()

Ensures that the view object has the dojo view helper path set.

Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\Zend_Dojo_Form_Element_Dijit
methodpublictranslatorIsDisabled() : bool
Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.0.0a12.