Form/Element/Multi.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-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
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

>VPropertyprotectedbool $_registerInArrayValidator = true
Flag: autoregister inArray validator?
Default valuetrueDetails
Type
bool
>VPropertyprotectedstring $_separator = '<br />'
Separator to use between options; defaults to '
'.
Default value'<br />'Details
Type
string
>VPropertyprotectedarray $_translated = array()
Which values are translated already?
Default valuearray()Details
Type
array
>VPropertypublicarray $options = array()
Array of options for multi-item
Default valuearray()Details
Type
array

Methods

methodprotected_getMultiOptions() : array

Retrieve options array

Returns
TypeDescription
array
methodprotected_translateOption(string $option, string $value) : bool

Translate an option

Parameters
NameTypeDescription
$optionstring
$valuestring
Returns
TypeDescription
bool
methodprotected_translateValue(string $value) : string

Translate a multi option value

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
methodpublicaddMultiOption(string $option, string $value = '') : \Zend_Form_Element_Multi

Add an option

Parameters
NameTypeDescription
$optionstring
$valuestring
Returns
TypeDescription
\Zend_Form_Element_Multi
methodpublicaddMultiOptions(array $options) : \Zend_Form_Element_Multi

Add many options at once

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Element_Multi
methodpublicclearMultiOptions() : \Zend_Form_Element_Multi

Clear all options

Returns
TypeDescription
\Zend_Form_Element_Multi
methodpublicgetMultiOption(string $option) : mixed

Retrieve single multi option

Parameters
NameTypeDescription
$optionstring
Returns
TypeDescription
mixed
methodpublicgetMultiOptions() : array

Retrieve options

Returns
TypeDescription
array
methodpublicgetSeparator() : mixed

Retrieve separator

Returns
TypeDescription
mixed
methodpublicisValid(string $value, mixed $context = null) : bool

Is the value provided valid?

Autoregisters InArray validator if necessary.
Parameters
NameTypeDescription
$valuestring
$contextmixed
Returns
TypeDescription
bool
methodpublicregisterInArrayValidator() : bool

Get status of auto-register inArray validator flag

Returns
TypeDescription
bool
methodpublicremoveMultiOption(string $option) : bool

Remove a single multi option

Parameters
NameTypeDescription
$optionstring
Returns
TypeDescription
bool
methodpublicsetMultiOptions(array $options) : \Zend_Form_Element_Multi

Set all options at once (overwrites)

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Element_Multi
methodpublicsetRegisterInArrayValidator(bool $flag) : \Zend_Form_Element_Multi

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

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element_Multi
methodpublicsetSeparator(mixed $separator) : \Zend_Form_Element_Multi

Set separator

Parameters
NameTypeDescription
$separatormixed
Returns
TypeDescription
\Zend_Form_Element_Multi
Details
Fluent
This method is part of a fluent interface and will return the same instance  
Documentation was generated by phpDocumentor 2.2.0 .