Base class for multi-option form elements

• version: $Id: Multi.php 22323 2010-05-30 11:15:38Z thomas $
• copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
• abstract:
• license: New BSD License

Located in /Form/Element/Multi.php (line 35)

Zend_Form_Element
   |
   --Zend_Form_Element_Xhtml
      |
      --Zend_Form_Element_Multi

array $options = array() (line 41)

Array of options for multi-item

• access: public

bool $_registerInArrayValidator = true (line 47)

Flag: autoregister inArray validator?

• access: protected

string $_separator = '<br />' (line 53)

Separator to use between options; defaults to '
'.

• access: protected

array $_translated = array() (line 59)

Which values are translated already?

• access: protected

Inherited Variables

Inherited from Zend_Form_Element

Zend_Form_Element::$helper
Zend_Form_Element::$_allowEmpty
Zend_Form_Element::$_autoInsertNotEmptyValidator
Zend_Form_Element::$_belongsTo
Zend_Form_Element::$_decorators
Zend_Form_Element::$_description
Zend_Form_Element::$_disableLoadDefaultDecorators
Zend_Form_Element::$_errorMessages
Zend_Form_Element::$_errorMessageSeparator
Zend_Form_Element::$_errors
Zend_Form_Element::$_filters
Zend_Form_Element::$_ignore
Zend_Form_Element::$_isArray
Zend_Form_Element::$_isError
Zend_Form_Element::$_isErrorForced
Zend_Form_Element::$_isPartialRendering
Zend_Form_Element::$_label
Zend_Form_Element::$_loaders
Zend_Form_Element::$_messages
Zend_Form_Element::$_name
Zend_Form_Element::$_order
Zend_Form_Element::$_required
Zend_Form_Element::$_translator
Zend_Form_Element::$_translatorDisabled
Zend_Form_Element::$_type
Zend_Form_Element::$_validatorRules
Zend_Form_Element::$_validators
Zend_Form_Element::$_value
Zend_Form_Element::$_view

addMultiOption (line 104)

Add an option

• access: public

Zend_Form_Element_Multi addMultiOption (string $option, [string $value = ''])

• string $option
• string $value

addMultiOptions (line 121)

Add many options at once

• access: public

Zend_Form_Element_Multi addMultiOptions ( $options)

• array $options

clearMultiOptions (line 206)

Clear all options

• access: public

Zend_Form_Element_Multi clearMultiOptions ()

getMultiOption (line 154)

Retrieve single multi option

• access: public

mixed getMultiOption (string $option)

• string $option

getMultiOptions (line 171)

Retrieve options

• access: public

array getMultiOptions ()

getSeparator (line 66)

Retrieve separator

• access: public

mixed getSeparator ()

isValid (line 244)

Is the value provided valid?

Autoregisters InArray validator if necessary.

• access: public

bool isValid (string $value, [mixed $context = null])

• string $value
• mixed $context

---

Redefinition of:

Zend_Form_Element::isValid()

Validate element value

registerInArrayValidator (line 230)

Get status of auto-register inArray validator flag

• access: public

bool registerInArrayValidator ()

removeMultiOption (line 186)

Remove a single multi option

• access: public

bool removeMultiOption (string $option)

• string $option

setMultiOptions (line 142)

Set all options at once (overwrites)

• access: public

Zend_Form_Element_Multi setMultiOptions ( $options)

• array $options

setRegisterInArrayValidator (line 219)

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

• access: public

Zend_Form_Element_Multi setRegisterInArrayValidator (bool $flag)

• bool $flag

setSeparator (line 77)

Set separator

• access: public

self setSeparator (mixed $separator)

• mixed $separator

_getMultiOptions (line 88)

Retrieve options array

• access: protected

array _getMultiOptions ()

_translateOption (line 278)

Translate an option

• access: protected

bool _translateOption (string $option, string $value)

• string $option
• string $value

_translateValue (line 302)

Translate a multi option value

• access: protected

string _translateValue (string $value)

• string $value

Inherited Methods

Inherited From Zend_Form_Element

Zend_Form_Element::__construct()
Zend_Form_Element::addDecorator()
Zend_Form_Element::addDecorators()
Zend_Form_Element::addError()
Zend_Form_Element::addErrorMessage()
Zend_Form_Element::addErrorMessages()
Zend_Form_Element::addErrors()
Zend_Form_Element::addFilter()
Zend_Form_Element::addFilters()
Zend_Form_Element::addPrefixPath()
Zend_Form_Element::addPrefixPaths()
Zend_Form_Element::addValidator()
Zend_Form_Element::addValidators()
Zend_Form_Element::autoInsertNotEmptyValidator()
Zend_Form_Element::clearDecorators()
Zend_Form_Element::clearErrorMessages()
Zend_Form_Element::clearFilters()
Zend_Form_Element::clearValidators()
Zend_Form_Element::filterName()
Zend_Form_Element::getAllowEmpty()
Zend_Form_Element::getAttrib()
Zend_Form_Element::getAttribs()
Zend_Form_Element::getBelongsTo()
Zend_Form_Element::getDecorator()
Zend_Form_Element::getDecorators()
Zend_Form_Element::getDescription()
Zend_Form_Element::getErrorMessages()
Zend_Form_Element::getErrorMessageSeparator()
Zend_Form_Element::getErrors()
Zend_Form_Element::getFilter()
Zend_Form_Element::getFilters()
Zend_Form_Element::getFullyQualifiedName()
Zend_Form_Element::getId()
Zend_Form_Element::getIgnore()
Zend_Form_Element::getLabel()
Zend_Form_Element::getMessages()
Zend_Form_Element::getName()
Zend_Form_Element::getOrder()
Zend_Form_Element::getPluginLoader()
Zend_Form_Element::getTranslator()
Zend_Form_Element::getType()
Zend_Form_Element::getUnfilteredValue()
Zend_Form_Element::getValidator()
Zend_Form_Element::getValidators()
Zend_Form_Element::getValue()
Zend_Form_Element::getView()
Zend_Form_Element::hasErrors()
Zend_Form_Element::hasTranslator()
Zend_Form_Element::init()
Zend_Form_Element::isArray()
Zend_Form_Element::isRequired()
Zend_Form_Element::isValid()
Zend_Form_Element::loadDefaultDecorators()
Zend_Form_Element::loadDefaultDecoratorsIsDisabled()
Zend_Form_Element::markAsError()
Zend_Form_Element::removeDecorator()
Zend_Form_Element::removeFilter()
Zend_Form_Element::removeValidator()
Zend_Form_Element::render()
Zend_Form_Element::setAllowEmpty()
Zend_Form_Element::setAttrib()
Zend_Form_Element::setAttribs()
Zend_Form_Element::setAutoInsertNotEmptyValidator()
Zend_Form_Element::setBelongsTo()
Zend_Form_Element::setConfig()
Zend_Form_Element::setDecorators()
Zend_Form_Element::setDescription()
Zend_Form_Element::setDisableLoadDefaultDecorators()
Zend_Form_Element::setDisableTranslator()
Zend_Form_Element::setErrorMessages()
Zend_Form_Element::setErrorMessageSeparator()
Zend_Form_Element::setErrors()
Zend_Form_Element::setFilters()
Zend_Form_Element::setIgnore()
Zend_Form_Element::setIsArray()
Zend_Form_Element::setLabel()
Zend_Form_Element::setName()
Zend_Form_Element::setOptions()
Zend_Form_Element::setOrder()
Zend_Form_Element::setPluginLoader()
Zend_Form_Element::setRequired()
Zend_Form_Element::setTranslator()
Zend_Form_Element::setValidators()
Zend_Form_Element::setValue()
Zend_Form_Element::setView()
Zend_Form_Element::translatorIsDisabled()
Zend_Form_Element::_filterValue()
Zend_Form_Element::_getDecorator()
Zend_Form_Element::_getErrorMessages()
Zend_Form_Element::_hasErrorMessages()
Zend_Form_Element::_loadDecorator()
Zend_Form_Element::_loadFilter()
Zend_Form_Element::_loadValidator()
Zend_Form_Element::__call()
Zend_Form_Element::__get()
Zend_Form_Element::__set()
Zend_Form_Element::__toString()

Inherited Constants

Inherited from Zend_Form_Element

Zend_Form_Element::DECORATOR
Zend_Form_Element::FILTER
Zend_Form_Element::VALIDATE