Form/Element/Multi.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Form
- Subpackage
- Element
\Zend_Form_Element_Multi
Package: Zend_Form\Element
Returns
Base class for multi-option form elements
- Parent(s)
- \Zend_Form_Element_Xhtml < \Zend_Form_Element
- Children
- \Zend_Form_Element_MultiCheckbox
- \Zend_Form_Element_Radio
- \Zend_Form_Element_Select
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Properties
bool $_registerInArrayValidator = trueFlag: autoregister inArray validator?
Default value
trueDetails- Type
- bool
string $_separator = '<br />'Separator to use between options; defaults to '
'.
'.
Default value
'<br />'Details- Type
- string
array $_translated = array()Which values are translated already?
Default value
array()Details- Type
- array
array $options = array()Array of options for multi-item
Default value
array()Details- Type
- array
Methods
_getMultiOptions() : arrayRetrieve options array
Returns
| Type | Description |
|---|---|
| array |
_translateOption(string $option, string $value) : boolTranslate an option
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $option | string | |
| $value | string |
| Type | Description |
|---|---|
| bool |
_translateValue(string $value) : stringTranslate a multi option value
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| string |
addMultiOption(string $option, string $value = '') : \Zend_Form_Element_MultiAdd an option
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $option | string | |
| $value | string |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |
addMultiOptions(array $options) : \Zend_Form_Element_MultiAdd many options at once
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |
clearMultiOptions() : \Zend_Form_Element_MultiClear all options
Returns
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |
getMultiOption(string $option) : mixedRetrieve single multi option
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $option | string |
| Type | Description |
|---|---|
| mixed |
getMultiOptions() : arrayRetrieve options
Returns
| Type | Description |
|---|---|
| array |
getSeparator() : mixedRetrieve separator
Returns
| Type | Description |
|---|---|
| mixed |
isValid(string $value, mixed $context = null) : boolIs the value provided valid?
Autoregisters InArray validator if necessary.
Parameters| Name | Type | Description |
|---|---|---|
| $value | string | |
| $context | mixed |
| Type | Description |
|---|---|
| bool |
registerInArrayValidator() : boolGet status of auto-register inArray validator flag
Returns
| Type | Description |
|---|---|
| bool |
removeMultiOption(string $option) : boolRemove a single multi option
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $option | string |
| Type | Description |
|---|---|
| bool |
setMultiOptions(array $options) : \Zend_Form_Element_MultiSet all options at once (overwrites)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |
setRegisterInArrayValidator(bool $flag) : \Zend_Form_Element_MultiSet flag indicating whether or not to auto-register inArray validator
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |
setSeparator(mixed $separator) : \Zend_Form_Element_MultiSet separator
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $separator | mixed |
| Type | Description |
|---|---|
| \Zend_Form_Element_Multi |
- Fluent
- This method is part of a fluent interface and will return the same instance