Dojo/Form/Element/RadioButton.php

Show: inherited
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 [email protected] 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_RadioButton

Package: Zend\Dojo\Form\Element

RadioButton dijit

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

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

Constants

Properties

Propertyprotectedbool $_autoInsertNotEmptyValidator = true
Propertyprotectedarray $_decorators = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_decorators  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_decorators  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_decorators  
Propertyprotectedstring $_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\Zend_Dojo_Form_Element_DijitMulti::$$_errorMessageSeparator
Propertyprotectedarray $_errors = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_errors  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_errors  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_errors  
Propertyprotectedarray $_filters = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_filters  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_filters  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_filters  
Propertyprotectedbool $_ignore = false
inherited

Ignore flag (used when retrieving values at form level)

Inherited from: \Zend_Form_Element::$$_ignore\Zend_Dojo_Form_Element_Dijit::$$_ignore\Zend_Dojo_Form_Element_DijitMulti::$$_ignore
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_ignore  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_ignore  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_ignore  
Propertyprotectedbool $_isArray = false
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isArray  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isArray  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_isArray  
Propertyprotectedbool $_isError = false
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isError  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isError  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_isError  
Propertyprotectedbool $_isErrorForced = false
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isErrorForced  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isErrorForced  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_isErrorForced  
Propertyprotectedbool $_isPartialRendering = false

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

Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isPartialRendering  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isPartialRendering  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_isPartialRendering  
Propertyprotectedarray $_loaders = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_loaders  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_loaders  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_loaders  
Propertyprotectedarray $_messages = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_messages  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_messages  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_messages  
Propertyprotectedbool $_registerInArrayValidator = true
inherited

Flag: autoregister inArray validator?

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::$$_registerInArrayValidator
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_registerInArrayValidator  
Propertyprotectedstring $_separator = '<br />'
inherited

Separator to use between options; defaults to '<br />'.

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::$$_separator
Default value'<br />'Details
Type
string
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_separator  
Propertyprotectedarray $_translated = array()
inherited

Which values are translated already?

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::$$_translated
Default valuearray()Details
Type
array
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_translated  
Propertyprotectedarray $_validatorRules = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_validatorRules  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_validatorRules  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_validatorRules  
Propertyprotectedarray $_validators = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Element::$$_validators  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_validators  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$_validators  
Propertypublicarray $dijitParams = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$dijitParams  
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$dijitParams  
Propertypublicstring $helper = 'RadioButton'

Use RadioButton dijit view helper

Default value'RadioButton'Details
Type
string
Propertypublicarray $options = array()
inherited

Array of options for multi-item

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::$$options
Default valuearray()Details
Type
array
Inherited_from
\Zend_Dojo_Form_Element_DijitMulti::$$options  

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()\Zend_Dojo_Form_Element_DijitMulti::__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

$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
methodpublic__get(string $key) : mixed

Prevents access to properties beginning with '_'.

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

Proxies to render().

Returns
Type Description
string
methodprotected_filterValue(string $value, string $key) : void
Parameters
Name Type Description
$value string
$key string
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()\Zend_Dojo_Form_Element_DijitMulti::_getDecorator()
Parameters
Name Type Description
$name string
$options null | array
Returns
Type Description
\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()\Zend_Dojo_Form_Element_DijitMulti::_getErrorMessages()
Returns
Type Description
array
methodprotected_getMultiOptions() : array
inherited

Retrieve options array

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::_getMultiOptions()
Returns
Type Description
array
methodprotected_hasErrorMessages() : bool
Returns
Type Description
bool
methodprotected_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_Interface
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
Parameters
Name Type Description
$filter array
Returns
Type Description
\Zend_Filter_Interface
methodprotected_loadValidator(array $validator) : \Zend_Validate_Interface
Parameters
Name Type Description
$validator array

Validator definition

Returns
Type Description
\Zend_Validate_Interface
methodprotected_translateOption(string $option, string $value) : bool
inherited

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
inherited

Translate a value

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::_translateValue()
Parameters
Name Type Description
$value array | string
Returns
Type Description
array | string
methodpublicaddDecorator(string | \Zend_Form_Decorator_Interface $decorator, array | \Zend_Config $options = null) : \Zend_Form_Element
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
Parameters
Name Type Description
$decorators array
Returns
Type Description
\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()\Zend_Dojo_Form_Element_DijitMulti::addError()
Parameters
Name Type Description
$message string
Returns
Type Description
\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()\Zend_Dojo_Form_Element_DijitMulti::addErrorMessage()
Parameters
Name Type Description
$message string
Returns
Type Description
\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()\Zend_Dojo_Form_Element_DijitMulti::addErrorMessages()
Parameters
Name Type Description
$messages array
Returns
Type Description
\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()\Zend_Dojo_Form_Element_DijitMulti::addErrors()
Parameters
Name Type Description
$messages array
Returns
Type Description
\Zend_Form_Element
methodpublicaddFilter(string | \Zend_Filter_Interface $filter,  $options = array()) : \Zend_Form_Element
Parameters
Name Type Description
$filter string | \Zend_Filter_Interface
$options
Returns
Type Description
\Zend_Form_Element
methodpublicaddFilters(array $filters) : \Zend_Form_Element
Parameters
Name Type Description
$filters array
Returns
Type Description
\Zend_Form_Element
methodpublicaddMultiOption(string $option, string $value = '') : \Zend_Form_Element_Multi
inherited

Add an option

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::addMultiOption()
Parameters
Name Type Description
$option string
$value string
Returns
Type Description
\Zend_Form_Element_Multi
methodpublicaddMultiOptions(array $options) : \Zend_Form_Element_Multi
inherited

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

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

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
Parameters
Name Type Description
$validators array
Returns
Type Description
\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()\Zend_Dojo_Form_Element_DijitMulti::autoInsertNotEmptyValidator()
Returns
Type Description
bool
methodpublicclearMultiOptions() : \Zend_Form_Element_Multi
inherited

Clear all options

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::clearMultiOptions()
Returns
Type Description
\Zend_Form_Element_Multi
methodpublicfilterName(string $value, bool $allowBrackets = false) : string
Parameters
Name Type Description
$value string
$allowBrackets bool
Returns
Type Description
string
methodpublicgetAllowEmpty() : bool
Returns
Type Description
bool
methodpublicgetAttrib(string $name) : string
Parameters
Name Type Description
$name string
Returns
Type Description
string
methodpublicgetAttribs() : array
Returns
Type Description
array
methodpublicgetBelongsTo() : string
Returns
Type Description
string
methodpublicgetDecorator(string $name) : false | \Zend_Form_Decorator_Abstract
Parameters
Name Type Description
$name string
Returns
Type Description
false | \Zend_Form_Decorator_Abstract
methodpublicgetDecorators() : array
Returns
Type Description
array
methodpublicgetDescription() : string
Returns
Type Description
string
methodpublicgetDijitParam(string $key) : mixed
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetDijitParams() : array
Returns
Type Description
array
methodpublicgetErrorMessageSeparator() : string
Returns
Type Description
string
methodpublicgetErrorMessages() : array
Returns
Type Description
array
methodpublicgetErrors() : array
Returns
Type Description
array
methodpublicgetFilter(string $name) : \Zend_Filter_Interface
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Filter_Interface
methodpublicgetFilters() : array
Returns
Type Description
array
methodpublicgetFullyQualifiedName() : string

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

Returns
Type Description
string
methodpublicgetId() : string
Returns
Type Description
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()\Zend_Dojo_Form_Element_DijitMulti::getIgnore()
Returns
Type Description
bool
methodpublicgetLabel() : string
Returns
Type Description
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
Type Description
array
methodpublicgetMultiOption(string $option) : mixed
inherited

Retrieve single multi option

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

Retrieve options

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::getMultiOptions()
Returns
Type Description
array
methodpublicgetName() : string
Returns
Type Description
string
methodpublicgetOrder() : int
Returns
Type Description
int
methodpublicgetPluginLoader(string $type) : \Zend_Loader_PluginLoader

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
inherited

Retrieve separator

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::getSeparator()
Returns
Type Description
mixed
methodpublicgetTranslator() : \Zend_Translate_Adapter | null
Returns
Type Description
\Zend_Translate_Adapter | null
methodpublicgetType() : string
Returns
Type Description
string
methodpublicgetUnfilteredValue() : mixed
Returns
Type Description
mixed
methodpublicgetValidator(string $name) : \Zend_Validate_Interface | false
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Validate_Interface | false False if not found, validator otherwise
methodpublicgetValidators() : array
Returns
Type Description
array
methodpublicgetValue() : mixed
Returns
Type Description
mixed
methodpublicgetView() : null | \Zend_View_Interface

Retrieves from ViewRenderer if none previously set.

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

Does the given dijit parameter exist?

Inherited from: \Zend_Dojo_Form_Element_Dijit::hasDijitParam()\Zend_Dojo_Form_Element_DijitMulti::hasDijitParam()
Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpublichasErrors() : bool
Returns
Type Description
bool
methodpublichasTranslator() : bool
Returns
Type Description
bool
methodpublicinit() : void
inherited

Initialize object; used by extending classes

Inherited from: \Zend_Form_Element::init()\Zend_Dojo_Form_Element_Dijit::init()\Zend_Dojo_Form_Element_DijitMulti::init()
methodpublicisArray() : bool
Returns
Type Description
bool
methodpublicisRequired() : bool
Returns
Type Description
bool
methodpublicisValid(string $value, mixed $context = null) : bool
inherited

Is the value provided valid?

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::isValid()

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
methodpublicloadDefaultDecoratorsIsDisabled() : bool
Returns
Type Description
bool
methodpublicmarkAsError() : \Zend_Form_Element
Returns
Type Description
\Zend_Form_Element
methodpublicregisterInArrayValidator() : bool
inherited

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
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Form_Element
methodpublicremoveDijitParam(string $key) : \Zend_Dojo_Form_Element_Dijit
Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublicremoveFilter(string $name) : \Zend_Form_Element
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Form_Element
methodpublicremoveMultiOption(string $option) : bool
inherited

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
Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublicrender(\Zend_View_Interface $view = null) : string
Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
string
methodpublicresolveElementId(\Zend_Form_Decorator_Interface $decorator) : string

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

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
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
Parameters
Name Type Description
$attribs array
Returns
Type Description
\Zend_Form_Element
methodpublicsetAutoInsertNotEmptyValidator(bool $flag) : \Zend_Form_Element
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetBelongsTo(string $array) : \Zend_Form_Element
Parameters
Name Type Description
$array string
Returns
Type Description
\Zend_Form_Element
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_Element
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_Element
methodpublicsetDecorators(array $decorators) : \Zend_Form_Element
Parameters
Name Type Description
$decorators array
Returns
Type Description
\Zend_Form_Element
methodpublicsetDescription(string $description) : \Zend_Form_Element
Parameters
Name Type Description
$description string
Returns
Type Description
\Zend_Form_Element
methodpublicsetDijitParam(string $key, mixed $value) : \Zend_Dojo_Form_Element_Dijit
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublicsetDijitParams(array $params) : \Zend_Dojo_Form_Element_Dijit
Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublicsetDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_Element
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetDisableTranslator(bool $flag) : \Zend_Form_Element
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetErrorMessageSeparator(string $separator) : \Zend_Form_Element
Parameters
Name Type Description
$separator string
Returns
Type Description
\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()\Zend_Dojo_Form_Element_DijitMulti::setErrorMessages()
Parameters
Name Type Description
$messages array
Returns
Type Description
\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()\Zend_Dojo_Form_Element_DijitMulti::setErrors()
Parameters
Name Type Description
$messages array
Returns
Type Description
\Zend_Form_Element
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()\Zend_Dojo_Form_Element_DijitMulti::setFilters()
Parameters
Name Type Description
$filters array
Returns
Type Description
\Zend_Form_Element
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()\Zend_Dojo_Form_Element_DijitMulti::setIgnore()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetIsArray(bool $flag) : \Zend_Form_Element
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Form_Element
methodpublicsetLabel(string $label) : \Zend_Form_Element
Parameters
Name Type Description
$label string
Returns
Type Description
\Zend_Form_Element
methodpublicsetMultiOptions(array $options) : \Zend_Form_Element_Multi
inherited

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
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Form_Element
methodpublicsetOptions(array $options) : \Zend_Form_Element
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Element
methodpublicsetOrder(int $order) : \Zend_Form_Element
Parameters
Name Type Description
$order int
Returns
Type Description
\Zend_Form_Element
methodpublicsetPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type) : \Zend_Form_Element
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
inherited

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
Parameters
Name Type Description
$flag bool

Default value is true

Returns
Type Description
\Zend_Form_Element
methodpublicsetSeparator(mixed $separator) : \Zend_Dojo_Form_Element_RadioButton
inherited

Set separator

Inherited from: \Zend_Dojo_Form_Element_DijitMulti::setSeparator()
Parameters
Name Type Description
$separator mixed
Returns
Type Description
\Zend_Dojo_Form_Element_RadioButton
Details
Fluent
This method is part of a fluent interface and will return the same instance  
methodpublicsetTranslator(\Zend_Translate | null $translator = null) : \Zend_Form_Element
Parameters
Name Type Description
$translator \Zend_Translate | null
Returns
Type Description
\Zend_Form_Element
methodpublicsetValidators(array $validators) : \Zend_Form_Element
Parameters
Name Type Description
$validators array
Returns
Type Description
\Zend_Form_Element
methodpublicsetValue(mixed $value) : \Zend_Form_Element
Parameters
Name Type Description
$value mixed
Returns
Type Description
\Zend_Form_Element
methodpublicsetView(\Zend_View_Interface $view = null) : \Zend_Dojo_Form_Element_Dijit

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
Returns
Type Description
bool
Documentation was generated by phpDocumentor 2.0.0a8.