Form/Element/Multi.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Form
subpackage: Element
Classes: Zend_Form_Element_Multi

Description

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.

Zend_Form_Element_Multi
jump to top

Extends from: Zend_Form_Element_Xhtml
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Form
subpackage: Element
version: $Id: Multi.php 22323 2010-05-30 11:15:38Z thomas $
Properties: $options; $_registerInArrayValidator; $_separator; $_translated
Methods: getSeparator; setSeparator; _getMultiOptions; addMultiOption; addMultiOptions; setMultiOptions; getMultiOption; getMultiOptions; removeMultiOption; clearMultiOptions; setRegisterInArrayValidator; registerInArrayValidator; isValid; _translateOption; _translateValue

Description

Base class for multi-option form elements

Properties

$_registerInArrayValidator
jump to class

bool $_registerInArrayValidator = 'true'

Flag: autoregister inArray validator?

Details

$_registerInArrayValidator: bool
visibility: protected
default: true
final: false
static: false

$_separator
jump to class

string $_separator = '<br />'

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

Details

$_separator: string
visibility: protected
default: <br />
final: false
static: false

$_translated
jump to class

array $_translated = 'array'

Which values are translated already?

Details

$_translated: array
visibility: protected
default: array
final: false
static: false

$options
jump to class

array $options = 'array'

Array of options for multi-item

Details

$options: array
visibility: public
default: array
final: false
static: false

Methods

_getMultiOptions
jump to class

_getMultiOptions(
          
          )
        
        :
        array

Retrieve options array

Output

array

Details

visibility: protected
final: false
static: false

_translateOption
jump to class

_translateOption(
          string $option, string $value
          )
        
        :
        bool

Translate an option

Arguments

$option: string
$value: string

Output

bool

Details

visibility: protected
final: false
static: false

_translateValue
jump to class

_translateValue(
          string $value
          )
        
        :
        string

Translate a multi option value

Arguments

$value: string

Output

string

Details

visibility: protected
final: false
static: false

addMultiOption
jump to class

addMultiOption(
          string $option, string $value
          )
        
        :
        Zend_Form_Element_Multi

Add an option

Arguments

$option: string
$value: string

Output

Zend_Form_Element_Multi

Details

visibility: public
final: false
static: false

addMultiOptions
jump to class

addMultiOptions(
          array $options
          )
        
        :
        Zend_Form_Element_Multi

Add many options at once

Arguments

$options: array

Output

Zend_Form_Element_Multi

Details

visibility: public
final: false
static: false

clearMultiOptions
jump to class

clearMultiOptions(
          
          )
        
        :
        Zend_Form_Element_Multi

Clear all options

Output

Zend_Form_Element_Multi

Details

visibility: public
final: false
static: false

getMultiOption
jump to class

getMultiOption(
          string $option
          )
        
        :
        mixed

Retrieve single multi option

Arguments

$option: string

Output

mixed

Details

visibility: public
final: false
static: false

getMultiOptions
jump to class

getMultiOptions(
          
          )
        
        :
        array

Retrieve options

Output

array

Details

visibility: public
final: false
static: false

getSeparator
jump to class

getSeparator(
          
          )
        
        :
        mixed

Retrieve separator

Output

mixed

Details

visibility: public
final: false
static: false

isValid
jump to class

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

Is the value provided valid?

Autoregisters InArray validator if necessary.

Arguments

$value: string
$context: mixed

Output

bool

Details

visibility: public
final: false
static: false

registerInArrayValidator
jump to class

registerInArrayValidator(
          
          )
        
        :
        bool

Get status of auto-register inArray validator flag

Output

bool

Details

visibility: public
final: false
static: false

removeMultiOption
jump to class

removeMultiOption(
          string $option
          )
        
        :
        bool

Remove a single multi option

Arguments

$option: string

Output

bool

Details

visibility: public
final: false
static: false

setMultiOptions
jump to class

setMultiOptions(
          array $options
          )
        
        :
        Zend_Form_Element_Multi

Set all options at once (overwrites)

Arguments

$options: array

Output

Zend_Form_Element_Multi

Details

visibility: public
final: false
static: false

setRegisterInArrayValidator
jump to class

setRegisterInArrayValidator(
          bool $flag
          )
        
        :
        Zend_Form_Element_Multi

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

Arguments

$flag: bool

Output

Zend_Form_Element_Multi

Details

visibility: public
final: false
static: false

setSeparator
jump to class

setSeparator(
          mixed $separator
          )
        
        :
        self

Set separator

Arguments

$separator: mixed

Output

self

Details

visibility: public
final: false
static: false

API Documentation

Form/Element/Multi.php

Description

Zend_Form_Element_Multijump to top

Description

Properties

$_registerInArrayValidatorjump to class

Details

$_separatorjump to class

Details

$_translatedjump to class

Details

$optionsjump to class

Details

Methods

_getMultiOptionsjump to class

Output

Details

_translateOptionjump to class

Arguments

Output

Details

_translateValuejump to class

Arguments

Output

Details

addMultiOptionjump to class

Arguments

Output

Details

addMultiOptionsjump to class

Arguments

Output

Details

clearMultiOptionsjump to class

Output

Details

getMultiOptionjump to class

Arguments

Output

Details

getMultiOptionsjump to class

Output

Details

getSeparatorjump to class

Output

Details

isValidjump to class

Arguments

Output

Details

registerInArrayValidatorjump to class

Output

Details

removeMultiOptionjump to class

Arguments

Output

Details

setMultiOptionsjump to class

Arguments

Output

Details

setRegisterInArrayValidatorjump to class

Arguments

Output

Details

setSeparatorjump to class

Arguments

Output

Details

Zend_Form_Element_Multi
jump to top

$_registerInArrayValidator
jump to class

$_separator
jump to class

$_translated
jump to class

$options
jump to class

_getMultiOptions
jump to class

_translateOption
jump to class

_translateValue
jump to class

addMultiOption
jump to class

addMultiOptions
jump to class

clearMultiOptions
jump to class

getMultiOption
jump to class

getMultiOptions
jump to class

getSeparator
jump to class

isValid
jump to class

registerInArrayValidator
jump to class

removeMultiOption
jump to class

setMultiOptions
jump to class

setRegisterInArrayValidator
jump to class

setSeparator
jump to class