Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Zend_Form_Element_Multi Class Reference

Public Member Functions

 getSeparator ()
 Retrieve separator.
 
 setSeparator ($separator)
 Set separator.
 
 addMultiOption ($option, $value= '')
 Add an option.
 
 addMultiOptions (array $options)
 Add many options at once.
 
 setMultiOptions (array $options)
 Set all options at once (overwrites)
 
 getMultiOption ($option)
 Retrieve single multi option.
 
 getMultiOptions ()
 Retrieve options.
 
 removeMultiOption ($option)
 Remove a single multi option.
 
 clearMultiOptions ()
 Clear all options.
 
 setRegisterInArrayValidator ($flag)
 Set flag indicating whether or not to auto-register inArray validator.
 
 registerInArrayValidator ()
 Get status of auto-register inArray validator flag.
 
 isValid ($value, $context=null)
 Is the value provided valid?
 

Public Attributes

 $options = array()
 

Protected Member Functions

 _getMultiOptions ()
 Retrieve options array.
 
 _translateOption ($option, $value)
 Translate an option.
 
 _translateValue ($value)
 Translate a multi option value.
 

Protected Attributes

 $_registerInArrayValidator = true
 
 $_separator = '<br />'
 
 $_translated = array()
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Form_Element
static resolveElementId (Zend_Form_Decorator_Interface $decorator)
 Used to resolve and return an element ID.
 

Member Function Documentation

_getMultiOptions ( )
protected

Retrieve options array.

Returns
array
_translateOption (   $option,
  $value 
)
protected

Translate an option.

Parameters
string$option
string$value
Returns
bool
_translateValue (   $value)
protected

Translate a multi option value.

Parameters
string$value
Returns
string
addMultiOption (   $option,
  $value = '' 
)

Add an option.

Parameters
string$option
string$value
Returns
Zend_Form_Element_Multi
addMultiOptions ( array  $options)

Add many options at once.

Parameters
array$options
Returns
Zend_Form_Element_Multi
clearMultiOptions ( )

Clear all options.

Returns
Zend_Form_Element_Multi
getMultiOption (   $option)

Retrieve single multi option.

Parameters
string$option
Returns
mixed
getMultiOptions ( )

Retrieve options.

Returns
array
getSeparator ( )

Retrieve separator.

Returns
mixed
isValid (   $value,
  $context = null 
)

Is the value provided valid?

Autoregisters InArray validator if necessary.

Parameters
string$value
mixed$context
Returns
bool
registerInArrayValidator ( )

Get status of auto-register inArray validator flag.

Returns
bool
removeMultiOption (   $option)

Remove a single multi option.

Parameters
string$option
Returns
bool
setMultiOptions ( array  $options)

Set all options at once (overwrites)

Parameters
array$options
Returns
Zend_Form_Element_Multi
setRegisterInArrayValidator (   $flag)

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

Parameters
bool$flag
Returns
Zend_Form_Element_Multi
setSeparator (   $separator)

Set separator.

Parameters
mixed$separator
Returns
self

Member Data Documentation

$_registerInArrayValidator = true
protected
$_separator = '<br />'
protected
$_translated = array()
protected
$options = array()