API Documentation

Dojo/Form/Element/ComboBox.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Dojo  
subpackage
Form_Element  

\Zend_Dojo_Form_Element_ComboBox

ComboBox dijit

Note: this would be easier with mixins or traits...

Extends from
\Zend_Dojo_Form_Element_DijitMulti
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Dojo  
subpackage
Form_Element  
uses
\Zend_Dojo_Form_Element_DijitMulti  
version
$Id: ComboBox.php 23775 2011-03-01 17:25:24Z ralph $  

Properties

Propertyprotectedbool  $_registerInArrayValidator= 'false'

Flag: autoregister inArray validator?

Default valuefalseDetails
Type
bool
Propertypublicstring  $helper= 'ComboBox'

Use ComboBox dijit view helper

Default valueComboBoxDetails
Type
string

Methods

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

Overloading: allow rendering specific decorators

Inherited from: \Zend_Form_Element::__call()

Call renderDecoratorName() to render a specific decorator.

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
string
Throws
Exception Description
\Zend_Form_Exception for invalid decorator or invalid method call
methodpublic__construct( mixed $spec, mixed $options = null ) : void

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
Name Type Description
$spec mixed
$options mixed
Throws
Exception Description
\Zend_Form_Exception if no element name after initialization
Details
todo
Should we set dojo view helper paths here?  
methodpublic__get( string $key ) : mixed

Overloading: retrieve object property

Inherited from: \Zend_Form_Element::__get()

Prevents access to properties beginning with '_'.

Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublic__set( string $key, mixed $value ) : \voide

Overloading: set object property

Inherited from: \Zend_Form_Element::__set()
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\voide
methodpublic__toString( ) : string

String representation of form element

Inherited from: \Zend_Form_Element::__toString()

Proxies to {@link render()}.

Returns
Type Description
string
methodprotected_filterValue( string $value, string $key ) : void

Filter a value

Inherited from: \Zend_Form_Element::_filterValue()
Parameters
Name Type Description
$value string
$key string
methodprotected_getDecorator( string $name, null|array $options ) : \Zend_Form_Decorator_Interface

Instantiate a decorator based on class name or class name fragment

Inherited from: \Zend_Form_Element::_getDecorator()
Parameters
Name Type Description
$name string
$options null|array
Returns
Type Description
\Zend_Form_Decorator_Interface
methodprotected_getErrorMessages( ) : array

Retrieve error messages and perform translation and value substitution

Inherited from: \Zend_Form_Element::_getErrorMessages()
Returns
Type Description
array
methodprotected_getMultiOptions( ) : array

Retrieve options array

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::_getMultiOptions()
Returns
Type Description
array
methodprotected_hasErrorMessages( ) : bool

Are there custom error messages registered?

Inherited from: \Zend_Form_Element::_hasErrorMessages()
Returns
Type Description
bool
methodprotected_loadDecorator( array $decorator, mixed $name ) : \Zend_Form_Decorator_Interface

Lazy-load a decorator

Inherited from: \Zend_Form_Element::_loadDecorator()
Parameters
Name Type Description
$decorator array Decorator type and options
$name mixed Decorator name or alias
Returns
Type Description
\Zend_Form_Decorator_Interface
methodprotected_loadFilter( array $filter ) : \Zend_Filter_Interface

Lazy-load a filter

Inherited from: \Zend_Form_Element::_loadFilter()
Parameters
Name Type Description
$filter array
Returns
Type Description
\Zend_Filter_Interface
methodprotected_loadValidator( array $validator ) : \Zend_Validate_Interface

Lazy-load a validator

Inherited from: \Zend_Form_Element::_loadValidator()
Parameters
Name Type Description
$validator array Validator definition
Returns
Type Description
\Zend_Validate_Interface
methodprotected_translateOption( string $option, string $value ) : bool

Translate an option

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::_translateOption()
Parameters
Name Type Description
$option string
$value string
Returns
Type Description
bool
methodprotected_translateValue( array|string $value ) : array|string

Translate a value

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::_translateValue()
Parameters
Name Type Description
$value array|string
Returns
Type Description
arraystring
methodpublicaddDecorator( string|\Zend_Form_Decorator_Interface $decorator, array|\Zend_Config $options = null ) : \Zend_Form_Element

Add a decorator for rendering the element

Inherited from: \Zend_Form_Element::addDecorator()
Parameters
Name Type Description
$decorator string|\Zend_Form_Decorator_Interface
$options array|\Zend_Config Options with which to initialize decorator
Returns
Type Description
\Zend_Form_Element
methodpublicaddDecorators( array $decorators ) : \Zend_Form_Element

Add many decorators at once

Inherited from: \Zend_Form_Element::addDecorators()
Parameters
Name Type Description
$decorators array
Returns
Type Description
\Zend_Form_Element
methodpublicaddError( string $message ) : \Zend_Form_Element

Add an error message and mark element as failed validation

Inherited from: \Zend_Form_Element::addError()
Parameters
Name Type Description
$message string
Returns
Type Description
\Zend_Form_Element
methodpublicaddErrorMessage( string $message ) : \Zend_Form_Element

Add a custom error message to return in the event of failed validation

Inherited from: \Zend_Form_Element::addErrorMessage()
Parameters
Name Type Description
$message string
Returns
Type Description
\Zend_Form_Element
methodpublicaddErrorMessages( array $messages ) : \Zend_Form_Element

Add multiple custom error messages to return in the event of failed validation

Inherited from: \Zend_Form_Element::addErrorMessages()
Parameters
Name Type Description
$messages array
Returns
Type Description
\Zend_Form_Element
methodpublicaddErrors( array $messages ) : \Zend_Form_Element

Add multiple error messages and flag element as failed validation

Inherited from: \Zend_Form_Element::addErrors()
Parameters
Name Type Description
$messages array
Returns
Type Description
\Zend_Form_Element
methodpublicaddFilter( string|\Zend_Filter_Interface $filter,  $options = array ) : \Zend_Form_Element

Add a filter to the element

Inherited from: \Zend_Form_Element::addFilter()
Parameters
Name Type Description
$filter string|\Zend_Filter_Interface
$options
Returns
Type Description
\Zend_Form_Element
methodpublicaddFilters( array $filters ) : \Zend_Form_Element

Add filters to element

Inherited from: \Zend_Form_Element::addFilters()
Parameters
Name Type Description
$filters array
Returns
Type Description
\Zend_Form_Element
methodpublicaddMultiOption( string $option, string $value ) : \Zend_Form_Element_Multi
Parameters
Name Type Description
$option string
$value string
Returns
Type Description
\Zend_Form_Element_Multi
methodpublicaddMultiOptions( array $options ) : \Zend_Form_Element_Multi

Add many options at once

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::addMultiOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Element_Multi
methodpublicaddPrefixPath( string $prefix, string $path, string $type = null ) : \Zend_Form_Element

Add prefix path for plugin loader

Inherited from: \Zend_Form_Element::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
Name Type Description
$prefix string
$path string
$type string
Returns
Type Description
\Zend_Form_Element
Throws
Exception Description
\Zend_Form_Exception for invalid type
methodpublicaddPrefixPaths( array $spec ) : \Zend_Form_Element

Add many prefix paths at once

Inherited from: \Zend_Form_Element::addPrefixPaths()
Parameters
Name Type Description
$spec array
Returns
Type Description
\Zend_Form_Element
methodpublicaddValidator( string|\Zend_Validate_Interface $validator, bool $breakChainOnFailure = false, array $options = array ) : \Zend_Form_Element

Add validator to validation chain

Inherited from: \Zend_Form_Element::addValidator()

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

Parameters
Name Type Description
$validator string|\Zend_Validate_Interface
$breakChainOnFailure bool
$options array
Returns
Type Description
\Zend_Form_Element
Throws
Exception Description
\Zend_Form_Exception if invalid validator type
methodpublicaddValidators( array $validators ) : \Zend_Form_Element

Add multiple validators

Inherited from: \Zend_Form_Element::addValidators()
Parameters
Name Type Description
$validators array
Returns
Type Description
\Zend_Form_Element
methodpublicautoInsertNotEmptyValidator( ) : bool

Get flag indicating whether a NotEmpty validator should be inserted when element is required

Inherited from: \Zend_Form_Element::autoInsertNotEmptyValidator()
Returns
Type Description
bool
methodpublicclearDecorators( ) : \Zend_Form_Element

Clear all decorators

Inherited from: \Zend_Form_Element::clearDecorators()
Returns
Type Description
\Zend_Form_Element
methodpublicclearDijitParams( ) : \Zend_Dojo_Form_Element_Dijit

Clear all dijit parameters

Inherited from: \Zend_Dojo_Form_Element_Dijit::clearDijitParams()
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublicclearErrorMessages( ) : \Zend_Form_Element

Clear custom error messages stack

Inherited from: \Zend_Form_Element::clearErrorMessages()
Returns
Type Description
\Zend_Form_Element
methodpublicclearFilters( ) : \Zend_Form_Element

Clear all filters

Inherited from: \Zend_Form_Element::clearFilters()
Returns
Type Description
\Zend_Form_Element
methodpublicclearMultiOptions( ) : \Zend_Form_Element_Multi
Returns
Type Description
\Zend_Form_Element_Multi
methodpublicclearValidators( ) : \Zend_Form_Element

Clear all validators

Inherited from: \Zend_Form_Element::clearValidators()
Returns
Type Description
\Zend_Form_Element
methodpublicfilterName( string $value, bool $allowBrackets = false ) : string

Filter a name to only allow valid variable characters

Inherited from: \Zend_Form_Element::filterName()
Parameters
Name Type Description
$value string
$allowBrackets bool
Returns
Type Description
string
methodpublicgetAllowEmpty( ) : bool

Get 'allow empty' flag

Inherited from: \Zend_Form_Element::getAllowEmpty()
Returns
Type Description
bool
methodpublicgetAttrib( string $name ) : string

Retrieve element attribute

Inherited from: \Zend_Form_Element::getAttrib()
Parameters
Name Type Description
$name string
Returns
Type Description
string
methodpublicgetAttribs( ) : array

Return all attributes

Inherited from: \Zend_Form_Element::getAttribs()
Returns
Type Description
array
methodpublicgetAutocomplete( ) : bool

Get autocomplete flag

Returns
Type Description
bool
methodpublicgetBelongsTo( ) : string

Return array name to which element belongs

Inherited from: \Zend_Form_Element::getBelongsTo()
Returns
Type Description
string
methodpublicgetDecorator( string $name ) : false|\Zend_Form_Decorator_Abstract

Retrieve a registered decorator

Inherited from: \Zend_Form_Element::getDecorator()
Parameters
Name Type Description
$name string
Returns
Type Description
false\Zend_Form_Decorator_Abstract
methodpublicgetDecorators( ) : array

Retrieve all decorators

Inherited from: \Zend_Form_Element::getDecorators()
Returns
Type Description
array
methodpublicgetDescription( ) : string

Retrieve element description

Inherited from: \Zend_Form_Element::getDescription()
Returns
Type Description
string
methodpublicgetDijitParam( string $key ) : mixed

Get a single dijit parameter

Inherited from: \Zend_Dojo_Form_Element_Dijit::getDijitParam()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetDijitParams( ) : array

Retrieve all dijit parameters

Inherited from: \Zend_Dojo_Form_Element_Dijit::getDijitParams()
Returns
Type Description
array
methodpublicgetErrorMessageSeparator( ) : string

Get errorMessageSeparator

Inherited from: \Zend_Form_Element::getErrorMessageSeparator()
Returns
Type Description
string
methodpublicgetErrorMessages( ) : array

Retrieve custom error messages

Inherited from: \Zend_Form_Element::getErrorMessages()
Returns
Type Description
array
methodpublicgetErrors( ) : array

Retrieve validator chain errors

Inherited from: \Zend_Form_Element::getErrors()
Returns
Type Description
array
methodpublicgetFilter( string $name ) : \Zend_Filter_Interface

Retrieve a single filter by name

Inherited from: \Zend_Form_Element::getFilter()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Filter_Interface
methodpublicgetFilters( ) : array

Get all filters

Inherited from: \Zend_Form_Element::getFilters()
Returns
Type Description
array
methodpublicgetFullyQualifiedName( ) : string

Get fully qualified name

Inherited from: \Zend_Form_Element::getFullyQualifiedName()

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

Returns
Type Description
string
methodpublicgetId( ) : string

Get element id

Inherited from: \Zend_Form_Element::getId()
Returns
Type Description
string
methodpublicgetIgnore( ) : bool

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

Inherited from: \Zend_Form_Element::getIgnore()
Returns
Type Description
bool
methodpublicgetLabel( ) : string

Retrieve element label

Inherited from: \Zend_Form_Element::getLabel()
Returns
Type Description
string
methodpublicgetMessages( ) : array

Retrieve error messages

Inherited from: \Zend_Form_Element::getMessages()

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

Returns
Type Description
array
methodpublicgetMultiOption( string $option ) : mixed

Retrieve single multi option

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::getMultiOption()
Parameters
Name Type Description
$option string
Returns
Type Description
mixed
methodpublicgetMultiOptions( ) : array
Returns
Type Description
array
methodpublicgetName( ) : string

Return element name

Inherited from: \Zend_Form_Element::getName()
Returns
Type Description
string
methodpublicgetOrder( ) : int

Retrieve element order

Inherited from: \Zend_Form_Element::getOrder()
Returns
Type Description
int
methodpublicgetPluginLoader( string $type ) : \Zend_Loader_PluginLoader

Retrieve 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.

Parameters
Name Type Description
$type string
Returns
Type Description
\Zend_Loader_PluginLoader
Throws
Exception Description
\Zend_Loader_Exception on invalid type.
methodpublicgetSeparator( ) : mixed

Retrieve separator

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::getSeparator()
Returns
Type Description
mixed
methodpublicgetStoreId( ) : string|null

Get datastore identifier

Returns
Type Description
stringnull
methodpublicgetStoreInfo( ) : array

Get datastore information

Returns
Type Description
array
methodpublicgetStoreParams( ) : array

Get datastore params

Returns
Type Description
array
methodpublicgetStoreType( ) : string|null

Get datastore dijit type

Returns
Type Description
stringnull
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Retrieve localization translator object

Inherited from: \Zend_Form_Element::getTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublicgetType( ) : string

Return element type

Inherited from: \Zend_Form_Element::getType()
Returns
Type Description
string
methodpublicgetUnfilteredValue( ) : mixed

Retrieve unfiltered element value

Inherited from: \Zend_Form_Element::getUnfilteredValue()
Returns
Type Description
mixed
methodpublicgetValidator( string $name ) : \Zend_Validate_Interface|false

Retrieve a single validator by name

Inherited from: \Zend_Form_Element::getValidator()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Validate_Interfacefalse False if not found, validator otherwise
methodpublicgetValidators( ) : array

Retrieve all validators

Inherited from: \Zend_Form_Element::getValidators()
Returns
Type Description
array
methodpublicgetValue( ) : mixed

Retrieve filtered element value

Inherited from: \Zend_Form_Element::getValue()
Returns
Type Description
mixed
methodpublicgetView( ) : null|\Zend_View_Interface

Retrieve view object

Inherited from: \Zend_Form_Element::getView()

Retrieves from ViewRenderer if none previously set.

Returns
Type Description
null\Zend_View_Interface
methodpublichasDijitParam( string $key ) : bool

Does the given dijit parameter exist?

Inherited from: \Zend_Dojo_Form_Element_Dijit::hasDijitParam()
Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpublichasErrors( ) : bool

Are there errors registered?

Inherited from: \Zend_Form_Element::hasErrors()
Returns
Type Description
bool
methodpublichasTranslator( ) : bool

Does this element have its own specific translator?

Inherited from: \Zend_Form_Element::hasTranslator()
Returns
Type Description
bool
methodpublicinit( ) : void

Initialize object; used by extending classes

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

Is the element representing an array?

Inherited from: \Zend_Form_Element::isArray()
Returns
Type Description
bool
methodpublicisRequired( ) : bool

Is the element required?

Inherited from: \Zend_Form_Element::isRequired()
Returns
Type Description
bool
methodpublicisValid( string $value, mixed $context = null ) : bool

Is the value valid?

Autoregisters InArray validator if necessary.

Parameters
Name Type Description
$value string
$context mixed
Returns
Type Description
bool
Throws
Exception Description
\Zend_Validate_Exception If validation of $value is impossible
methodpublicloadDefaultDecorators( ) : void

Load default decorators

Inherited from: \Zend_Dojo_Form_Element_Dijit::loadDefaultDecorators()
methodpublicloadDefaultDecoratorsIsDisabled( ) : bool

Should we load the default decorators?

Inherited from: \Zend_Form_Element::loadDefaultDecoratorsIsDisabled()
Returns
Type Description
bool
methodpublicmarkAsError( ) : \Zend_Form_Element

Mark the element as being in a failed validation state

Inherited from: \Zend_Form_Element::markAsError()
Returns
Type Description
\Zend_Form_Element
methodpublicregisterInArrayValidator( ) : bool

Get status of auto-register inArray validator flag

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::registerInArrayValidator()
Returns
Type Description
bool
methodpublicremoveDecorator( string $name ) : \Zend_Form_Element

Remove a single decorator

Inherited from: \Zend_Form_Element::removeDecorator()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Form_Element
methodpublicremoveDijitParam( string $key ) : \Zend_Dojo_Form_Element_Dijit

Remove a single dijit parameter

Inherited from: \Zend_Dojo_Form_Element_Dijit::removeDijitParam()
Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublicremoveFilter( string $name ) : \Zend_Form_Element

Remove a filter by name

Inherited from: \Zend_Form_Element::removeFilter()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Form_Element
methodpublicremoveMultiOption( string $option ) : bool

Remove a single multi option

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::removeMultiOption()
Parameters
Name Type Description
$option string
Returns
Type Description
bool
methodpublicremoveValidator( string $name ) : bool

Remove a single validator by name

Inherited from: \Zend_Form_Element::removeValidator()
Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublicrender( \Zend_View_Interface $view = null ) : string

Render form element

Inherited from: \Zend_Form_Element::render()
Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
string
methodpublicresolveElementId( \Zend_Form_Decorator_Interface $decorator ) : string
static

Used 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.

Parameters
Name Type Description
$decorator \Zend_Form_Decorator_Interface
Returns
Type Description
string
methodpublicsetAllowEmpty( bool $flag ) : \Zend_Form_Element

Set 'allow empty' flag

Inherited from: \Zend_Form_Element::setAllowEmpty()

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

Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetAttrib( string $name, mixed $value ) : \Zend_Form_Element

Set element attribute

Inherited from: \Zend_Form_Element::setAttrib()
Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Form_Element
Throws
Exception Description
\Zend_Form_Exception for invalid $name values
methodpublicsetAttribs( array $attribs ) : \Zend_Form_Element

Set multiple attributes at once

Inherited from: \Zend_Form_Element::setAttribs()
Parameters
Name Type Description
$attribs array
Returns
Type Description
\Zend_Form_Element
methodpublicsetAutoInsertNotEmptyValidator( bool $flag ) : \Zend_Form_Element

Set flag indicating whether a NotEmpty validator should be inserted when element is required

Inherited from: \Zend_Form_Element::setAutoInsertNotEmptyValidator()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetAutocomplete( bool $flag ) : \Zend_Dojo_Form_Element_ComboBox

Set autocomplete flag

Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Dojo_Form_Element_ComboBox
methodpublicsetBelongsTo( string $array ) : \Zend_Form_Element

Set array to which element belongs

Inherited from: \Zend_Form_Element::setBelongsTo()
Parameters
Name Type Description
$array string
Returns
Type Description
\Zend_Form_Element
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Form_Element

Set object state from Zend_Config object

Inherited from: \Zend_Form_Element::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_Element
methodpublicsetDecorators( array $decorators ) : \Zend_Form_Element

Overwrite all decorators

Inherited from: \Zend_Form_Element::setDecorators()
Parameters
Name Type Description
$decorators array
Returns
Type Description
\Zend_Form_Element
methodpublicsetDescription( string $description ) : \Zend_Form_Element

Set element description

Inherited from: \Zend_Form_Element::setDescription()
Parameters
Name Type Description
$description string
Returns
Type Description
\Zend_Form_Element
methodpublicsetDijitParam( string $key, mixed $value ) : \Zend_Dojo_Form_Element_Dijit

Set a dijit parameter

Inherited from: \Zend_Dojo_Form_Element_Dijit::setDijitParam()
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublicsetDijitParams( array $params ) : \Zend_Dojo_Form_Element_Dijit

Set multiple dijit params at once

Inherited from: \Zend_Dojo_Form_Element_Dijit::setDijitParams()
Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublicsetDisableLoadDefaultDecorators( bool $flag ) : \Zend_Form_Element

Set flag to disable loading default decorators

Inherited from: \Zend_Form_Element::setDisableLoadDefaultDecorators()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetDisableTranslator( bool $flag ) : \Zend_Form_Element

Indicate whether or not translation should be disabled

Inherited from: \Zend_Form_Element::setDisableTranslator()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetErrorMessageSeparator( string $separator ) : \Zend_Form_Element

Set errorMessageSeparator

Inherited from: \Zend_Form_Element::setErrorMessageSeparator()
Parameters
Name Type Description
$separator string
Returns
Type Description
\Zend_Form_Element
methodpublicsetErrorMessages( array $messages ) : \Zend_Form_Element

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

Inherited from: \Zend_Form_Element::setErrorMessages()
Parameters
Name Type Description
$messages array
Returns
Type Description
\Zend_Form_Element
methodpublicsetErrors( array $messages ) : \Zend_Form_Element

Overwrite any previously set error messages and flag as failed validation

Inherited from: \Zend_Form_Element::setErrors()
Parameters
Name Type Description
$messages array
Returns
Type Description
\Zend_Form_Element
methodpublicsetFilters( array $filters ) : \Zend_Form_Element

Add filters to element, overwriting any already existing

Inherited from: \Zend_Form_Element::setFilters()
Parameters
Name Type Description
$filters array
Returns
Type Description
\Zend_Form_Element
methodpublicsetIgnore( bool $flag ) : \Zend_Form_Element

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

Inherited from: \Zend_Form_Element::setIgnore()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetIsArray( bool $flag ) : \Zend_Form_Element

Set flag indicating if element represents an array

Inherited from: \Zend_Form_Element::setIsArray()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetLabel( string $label ) : \Zend_Form_Element

Set element label

Inherited from: \Zend_Form_Element::setLabel()
Parameters
Name Type Description
$label string
Returns
Type Description
\Zend_Form_Element
methodpublicsetMultiOptions( array $options ) : \Zend_Form_Element_Multi

Set all options at once (overwrites)

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::setMultiOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Element_Multi
methodpublicsetName( string $name ) : \Zend_Form_Element

Set element name

Inherited from: \Zend_Form_Element::setName()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Form_Element
methodpublicsetOptions( array $options ) : \Zend_Form_Element

Set object state from options array

Inherited from: \Zend_Form_Element::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Element
methodpublicsetOrder( int $order ) : \Zend_Form_Element

Set element order

Inherited from: \Zend_Form_Element::setOrder()
Parameters
Name Type Description
$order int
Returns
Type Description
\Zend_Form_Element
methodpublicsetPluginLoader( \Zend_Loader_PluginLoader_Interface $loader, string $type ) : \Zend_Form_Element

Set plugin loader to use for validator or filter chain

Inherited from: \Zend_Form_Element::setPluginLoader()
Parameters
Name Type Description
$loader \Zend_Loader_PluginLoader_Interface
$type string

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

Returns
Type Description
\Zend_Form_Element
Throws
Exception Description
\Zend_Form_Exception on invalid type
methodpublicsetRegisterInArrayValidator( bool $flag ) : \Zend_Form_Element_Multi

Set flag indicating whether or not to auto-register inArray validator

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::setRegisterInArrayValidator()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element_Multi
methodpublicsetRequired( bool $flag = true ) : \Zend_Form_Element

Set required flag

Inherited from: \Zend_Form_Element::setRequired()
Parameters
Name Type Description
$flag bool Default value is true
Returns
Type Description
\Zend_Form_Element
methodpublicsetSeparator( mixed $separator ) : \Zend_Dojo_Form_Element_ComboBox
Parameters
Name Type Description
$separator mixed
Returns
Type Description
\Zend_Dojo_Form_Element_ComboBox
Details
fluent
This method is part of a fluent interface and will return the same instance  
methodpublicsetStoreId( string $identifier ) : \Zend_Dojo_Form_Element_ComboBox

Set datastore identifier

Parameters
Name Type Description
$identifier string
Returns
Type Description
\Zend_Dojo_Form_Element_ComboBox
methodpublicsetStoreParams( array $params ) : \Zend_Dojo_Form_Element_ComboBox

Set datastore parameters

Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Dojo_Form_Element_ComboBox
methodpublicsetStoreType( string $dojoType ) : \Zend_Dojo_Form_Element_ComboBox

Set datastore dijit type

Parameters
Name Type Description
$dojoType string
Returns
Type Description
\Zend_Dojo_Form_Element_ComboBox
methodpublicsetTranslator( \Zend_Translate|null $translator = null ) : \Zend_Form_Element

Set translator object for localization

Inherited from: \Zend_Form_Element::setTranslator()
Parameters
Name Type Description
$translator \Zend_Translate|null
Returns
Type Description
\Zend_Form_Element
methodpublicsetValidators( array $validators ) : \Zend_Form_Element

Set multiple validators, overwriting previous validators

Inherited from: \Zend_Form_Element::setValidators()
Parameters
Name Type Description
$validators array
Returns
Type Description
\Zend_Form_Element
methodpublicsetValue( mixed $value ) : \Zend_Form_Element

Set element value

Inherited from: \Zend_Form_Element::setValue()
Parameters
Name Type Description
$value mixed
Returns
Type Description
\Zend_Form_Element
methodpublicsetView( \Zend_View_Interface $view = null ) : \Zend_Dojo_Form_Element_Dijit

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
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublictranslatorIsDisabled( ) : bool

Is translation disabled?

Inherited from: \Zend_Form_Element::translatorIsDisabled()
Returns
Type Description
bool
Documentation was generated by DocBlox 0.13.3.