Form/Element.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
Classes: Zend_Form_Element

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
jump to top

Implements: Zend_Validate_Interface
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: Element.php 22465 2010-06-19 17:41:03Z alab $
Constants: DECORATOR; FILTER; VALIDATE
Properties: $helper; $_allowEmpty; $_autoInsertNotEmptyValidator; $_belongsTo; $_decorators; $_description; $_disableLoadDefaultDecorators; $_errorMessages; $_errors; $_errorMessageSeparator; $_filters; $_ignore; $_isArray; $_isError; $_isErrorForced; $_label; $_loaders; $_messages; $_name; $_order; $_required; $_translator; $_translatorDisabled; $_type; $_validators; $_validatorRules; $_value; $_view; $_isPartialRendering
Methods: __construct; init; setDisableLoadDefaultDecorators; loadDefaultDecoratorsIsDisabled; loadDefaultDecorators; setOptions; setConfig; setTranslator; getTranslator; hasTranslator; setDisableTranslator; translatorIsDisabled; filterName; setName; getName; getFullyQualifiedName; getId; setValue; _filterValue; getValue; getUnfilteredValue; setLabel; getLabel; setOrder; getOrder; setRequired; isRequired; setAutoInsertNotEmptyValidator; autoInsertNotEmptyValidator; setDescription; getDescription; setAllowEmpty; getAllowEmpty; setIgnore; getIgnore; setIsArray; isArray; setBelongsTo; getBelongsTo; getType; setAttrib; setAttribs; getAttrib; getAttribs; __get; __set; __call; setPluginLoader; getPluginLoader; addPrefixPath; addPrefixPaths; addValidator; addValidators; setValidators; getValidator; getValidators; removeValidator; clearValidators; isValid; addErrorMessage; addErrorMessages; setErrorMessages; getErrorMessages; clearErrorMessages; getErrorMessageSeparator; setErrorMessageSeparator; markAsError; addError; addErrors; setErrors; hasErrors; getErrors; getMessages; addFilter; addFilters; setFilters; getFilter; getFilters; removeFilter; clearFilters; setView; getView; _getDecorator; addDecorator; addDecorators; setDecorators; getDecorator; getDecorators; removeDecorator; clearDecorators; render; __toString; _loadFilter; _loadValidator; _loadDecorator; _getErrorMessages; _hasErrorMessages

Description

Zend_Form_Element

Constants

DECORATOR
jump to class

 DECORATOR = 'DECORATOR'

Element Constants

Details

value: DECORATOR

FILTER
jump to class

 FILTER = 'FILTER'

Details

value: FILTER

VALIDATE
jump to class

 VALIDATE = 'VALIDATE'

Details

value: VALIDATE

Properties

$_allowEmpty
jump to class

bool $_allowEmpty = 'true'

'Allow empty' flag

Details

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

$_autoInsertNotEmptyValidator
jump to class

bool $_autoInsertNotEmptyValidator = 'true'

Flag indicating whether or not to insert NotEmpty validator when element is required

Details

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

$_belongsTo
jump to class

string $_belongsTo = ''

Array to which element belongs

Details

$_belongsTo: string
visibility: protected
default
final: false
static: false

$_decorators
jump to class

array $_decorators = 'array'

Element decorators

Details

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

$_description
jump to class

string $_description = ''

Element description

Details

$_description: string
visibility: protected
default
final: false
static: false

$_disableLoadDefaultDecorators
jump to class

bool $_disableLoadDefaultDecorators = 'false'

Should we disable loading the default decorators?

Details

$_disableLoadDefaultDecorators: bool
visibility: protected
default: false
final: false
static: false

$_errorMessageSeparator
jump to class

string $_errorMessageSeparator = '; '

Separator to use when concatenating aggregate error messages (for elements having array values)

Details

$_errorMessageSeparator: string
visibility: protected
default: ;
final: false
static: false

$_errorMessages
jump to class

array $_errorMessages = 'array'

Custom error messages

Details

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

$_errors
jump to class

array $_errors = 'array'

Validation errors

Details

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

$_filters
jump to class

array $_filters = 'array'

Element filters

Details

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

$_ignore
jump to class

bool $_ignore = 'false'

Ignore flag (used when retrieving values at form level)

Details

$_ignore: bool
visibility: protected
default: false
final: false
static: false

$_isArray
jump to class

bool $_isArray = 'false'

Does the element represent an array?

Details

$_isArray: bool
visibility: protected
default: false
final: false
static: false

$_isError
jump to class

bool $_isError = 'false'

Is the error marked as in an invalid state?

Details

$_isError: bool
visibility: protected
default: false
final: false
static: false

$_isErrorForced
jump to class

bool $_isErrorForced = 'false'

Has the element been manually marked as invalid?

Details

$_isErrorForced: bool
visibility: protected
default: false
final: false
static: false

$_isPartialRendering
jump to class

bool $_isPartialRendering = 'false'

Is a specific decorator being rendered via the magic renderDecorator()?

This is to allow execution of logic inside the render() methods of child elements during the magic call while skipping the parent render() method.

Details

$_isPartialRendering: bool
visibility: protected
default: false
final: false
static: false

$_label
jump to class

string $_label = ''

Element label

Details

$_label: string
visibility: protected
default
final: false
static: false

$_loaders
jump to class

array $_loaders = 'array'

Plugin loaders for filter and validator chains

Details

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

$_messages
jump to class

array $_messages = 'array'

Formatted validation error messages

Details

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

$_name
jump to class

string $_name = ''

Element name

Details

$_name: string
visibility: protected
default
final: false
static: false

$_order
jump to class

int $_order = ''

Order of element

Details

$_order: int
visibility: protected
default
final: false
static: false

$_required
jump to class

bool $_required = 'false'

Required flag

Details

$_required: bool
visibility: protected
default: false
final: false
static: false

$_translator
jump to class

Zend_Translate $_translator = ''

Details

$_translator: Zend_Translate
visibility: protected
default
final: false
static: false

$_translatorDisabled
jump to class

bool $_translatorDisabled = 'false'

Is translation disabled?

Details

$_translatorDisabled: bool
visibility: protected
default: false
final: false
static: false

$_type
jump to class

string $_type = ''

Element type

Details

$_type: string
visibility: protected
default
final: false
static: false

$_validatorRules
jump to class

array $_validatorRules = 'array'

Array of un-initialized validators

Details

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

$_validators
jump to class

array $_validators = 'array'

Array of initialized validators

Details

$_validators: array
Validators
visibility: protected
default: array
final: false
static: false

$_value
jump to class

mixed $_value = ''

Element value

Details

$_value: mixed
visibility: protected
default
final: false
static: false

$_view
jump to class

Zend_View_Interface $_view = ''

Details

$_view: Zend_View_Interface
visibility: protected
default
final: false
static: false

$helper
jump to class

string $helper = 'formText'

Default view helper to use

Details

$helper: string
visibility: public
default: formText
final: false
static: false

Methods

__call
jump to class

__call(
          string $method, array $args
          )
        
        :
        string

Overloading: allow rendering specific decorators

Call renderDecoratorName() to render a specific decorator.

Arguments

$method: string
$args: array

Output

string

Details

visibility: public
final: false
static: false
throws: for invalid decorator or invalid method call

__construct
jump to class

__construct(
          string|array|Zend_Config $spec, array|Zend_Config $options
              =
              null
          )
        
        :
        void

Constructor

$spec may be: - string: name of element - array: options with which to configure element - Zend_Config: Zend_Config with options for configuring element

Arguments

$spec: stringarrayZend_Config
$options: arrayZend_Config

Details

visibility: public
final: false
static: false
throws: if no element name after initialization

__get
jump to class

__get(
          string $key
          )
        
        :
        mixed

Overloading: retrieve object property

Prevents access to properties beginning with '_'.

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

__set
jump to class

__set(
          string $key, mixed $value
          )
        
        :
        voide

Overloading: set object property

Arguments

$key: string
$value: mixed

Output

voide

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

String representation of form element

Proxies to {@link render()}.

Output

string

Details

visibility: public
final: false
static: false

_filterValue
jump to class

_filterValue(
          string $value, string $key
          )
        
        :
        void

Filter a value

Arguments

$value: string
$key: string

Details

visibility: protected
final: false
static: false

_getDecorator
jump to class

_getDecorator(
          string $name, null|array $options
          )
        
        :
        Zend_Form_Decorator_Interface

Instantiate a decorator based on class name or class name fragment

Arguments

$name: string
$options: nullarray

Output

Zend_Form_Decorator_Interface

Details

visibility: protected
final: false
static: false

_getErrorMessages
jump to class

_getErrorMessages(
          
          )
        
        :
        array

Retrieve error messages and perform translation and value substitution

Output

array

Details

visibility: protected
final: false
static: false

_hasErrorMessages
jump to class

_hasErrorMessages(
          
          )
        
        :
        bool

Are there custom error messages registered?

Output

bool

Details

visibility: protected
final: false
static: false

_loadDecorator
jump to class

_loadDecorator(
          array $decorator, mixed $name
          )
        
        :
        Zend_Form_Decorator_Interface

Lazy-load a decorator

Arguments

$decorator: array
Decorator type and options
$name: mixed
Decorator name or alias

Output

Zend_Form_Decorator_Interface

Details

visibility: protected
final: false
static: false

_loadFilter
jump to class

_loadFilter(
          array $filter
          )
        
        :
        Zend_Filter_Interface

Lazy-load a filter

Arguments

$filter: array

Output

Zend_Filter_Interface

Details

visibility: protected
final: false
static: false

_loadValidator
jump to class

_loadValidator(
          array $validator
          )
        
        :
        Zend_Validate_Interface

Lazy-load a validator

Arguments

$validator: array
Validator definition

Output

Zend_Validate_Interface

Details

visibility: protected
final: false
static: false

addDecorator
jump to class

addDecorator(
          string|Zend_Form_Decorator_Interface $decorator, array|Zend_Config $options
              =
              null
          )
        
        :
        Zend_Form_Element

Add a decorator for rendering the element

Arguments

$decorator: stringZend_Form_Decorator_Interface
$options: arrayZend_Config
Options with which to initialize decorator

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addDecorators
jump to class

addDecorators(
          array $decorators
          )
        
        :
        Zend_Form_Element

Add many decorators at once

Arguments

$decorators: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addError
jump to class

addError(
          string $message
          )
        
        :
        Zend_Form_Element

Add an error message and mark element as failed validation

Arguments

$message: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addErrorMessage
jump to class

addErrorMessage(
          string $message
          )
        
        :
        Zend_Form_Element

Add a custom error message to return in the event of failed validation

Arguments

$message: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addErrorMessages
jump to class

addErrorMessages(
          array $messages
          )
        
        :
        Zend_Form_Element

Add multiple custom error messages to return in the event of failed validation

Arguments

$messages: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addErrors
jump to class

addErrors(
          array $messages
          )
        
        :
        Zend_Form_Element

Add multiple error messages and flag element as failed validation

Arguments

$messages: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addFilter
jump to class

addFilter(
          string|Zend_Filter_Interface $filter,  $options
              =
              array
          )
        
        :
        Zend_Form_Element

Add a filter to the element

Arguments

$filter: stringZend_Filter_Interface
$options

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addFilters
jump to class

addFilters(
          array $filters
          )
        
        :
        Zend_Form_Element

Add filters to element

Arguments

$filters: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addPrefixPath
jump to class

addPrefixPath(
          string $prefix, string $path, string $type
              =
              null
          )
        
        :
        Zend_Form_Element

Add prefix path for plugin loader

If no $type specified, assumes it is a base path for both filters and validators, and sets each according to the following rules: - decorators: $prefix = $prefix . '_Decorator' - filters: $prefix = $prefix . '_Filter' - validators: $prefix = $prefix . '_Validate'

Otherwise, the path prefix is set on the appropriate plugin loader.

Arguments

$prefix: string
$path: string
$type: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false
throws: for invalid type

addPrefixPaths
jump to class

addPrefixPaths(
          array $spec
          )
        
        :
        Zend_Form_Element

Add many prefix paths at once

Arguments

$spec: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

addValidator
jump to class

addValidator(
          string|Zend_Validate_Interface $validator, bool $breakChainOnFailure
              =
              false, array $options
              =
              array
          )
        
        :
        Zend_Form_Element

Add validator to validation chain

Note: will overwrite existing validators if they are of the same class.

Arguments

$validator: stringZend_Validate_Interface
$breakChainOnFailure: bool
$options: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false
throws: if invalid validator type

addValidators
jump to class

addValidators(
          array $validators
          )
        
        :
        Zend_Form_Element

Add multiple validators

Arguments

$validators: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

autoInsertNotEmptyValidator
jump to class

autoInsertNotEmptyValidator(
          
          )
        
        :
        bool

Get flag indicating whether a NotEmpty validator should be inserted when element is required

Output

bool

Details

visibility: public
final: false
static: false

clearDecorators
jump to class

clearDecorators(
          
          )
        
        :
        Zend_Form_Element

Clear all decorators

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

clearErrorMessages
jump to class

clearErrorMessages(
          
          )
        
        :
        Zend_Form_Element

Clear custom error messages stack

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

clearFilters
jump to class

clearFilters(
          
          )
        
        :
        Zend_Form_Element

Clear all filters

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

clearValidators
jump to class

clearValidators(
          
          )
        
        :
        Zend_Form_Element

Clear all validators

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

filterName
jump to class

filterName(
          string $value, bool $allowBrackets
              =
              false
          )
        
        :
        string

Filter a name to only allow valid variable characters

Arguments

$value: string
$allowBrackets: bool

Output

string

Details

visibility: public
final: false
static: false

getAllowEmpty
jump to class

getAllowEmpty(
          
          )
        
        :
        bool

Get 'allow empty' flag

Output

bool

Details

visibility: public
final: false
static: false

getAttrib
jump to class

getAttrib(
          string $name
          )
        
        :
        string

Retrieve element attribute

Arguments

$name: string

Output

string

Details

visibility: public
final: false
static: false

getAttribs
jump to class

getAttribs(
          
          )
        
        :
        array

Return all attributes

Output

array

Details

visibility: public
final: false
static: false

getBelongsTo
jump to class

getBelongsTo(
          
          )
        
        :
        string

Return array name to which element belongs

Output

string

Details

visibility: public
final: false
static: false

getDecorator
jump to class

getDecorator(
          string $name
          )
        
        :
        false|Zend_Form_Decorator_Abstract

Retrieve a registered decorator

Arguments

$name: string

Output

false|Zend_Form_Decorator_Abstract

Details

visibility: public
final: false
static: false

getDecorators
jump to class

getDecorators(
          
          )
        
        :
        array

Retrieve all decorators

Output

array

Details

visibility: public
final: false
static: false

getDescription
jump to class

getDescription(
          
          )
        
        :
        string

Retrieve element description

Output

string

Details

visibility: public
final: false
static: false

getErrorMessageSeparator
jump to class

getErrorMessageSeparator(
          
          )
        
        :
        string

Get errorMessageSeparator

Output

string

Details

visibility: public
final: false
static: false

getErrorMessages
jump to class

getErrorMessages(
          
          )
        
        :
        array

Retrieve custom error messages

Output

array

Details

visibility: public
final: false
static: false

getErrors
jump to class

getErrors(
          
          )
        
        :
        array

Retrieve validator chain errors

Output

array

Details

visibility: public
final: false
static: false

getFilter
jump to class

getFilter(
          string $name
          )
        
        :
        Zend_Filter_Interface

Retrieve a single filter by name

Arguments

$name: string

Output

Zend_Filter_Interface

Details

visibility: public
final: false
static: false

getFilters
jump to class

getFilters(
          
          )
        
        :
        array

Get all filters

Output

array

Details

visibility: public
final: false
static: false

getFullyQualifiedName
jump to class

getFullyQualifiedName(
          
          )
        
        :
        string

Get fully qualified name

Places name as subitem of array and/or appends brackets.

Output

string

Details

visibility: public
final: false
static: false

getId
jump to class

getId(
          
          )
        
        :
        string

Get element id

Output

string

Details

visibility: public
final: false
static: false

getIgnore
jump to class

getIgnore(
          
          )
        
        :
        bool

Get ignore flag (used when retrieving values at form level)

Output

bool

Details

visibility: public
final: false
static: false

getLabel
jump to class

getLabel(
          
          )
        
        :
        string

Retrieve element label

Output

string

Details

visibility: public
final: false
static: false

getMessages
jump to class

getMessages(
          
          )
        
        :
        array

Retrieve error messages

Output

array

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        string

Return element name

Output

string

Details

visibility: public
final: false
static: false

getOrder
jump to class

getOrder(
          
          )
        
        :
        int

Retrieve element order

Output

int

Details

visibility: public
final: false
static: false

getPluginLoader
jump to class

getPluginLoader(
          string $type
          )
        
        :
        Zend_Loader_PluginLoader

Retrieve plugin loader for validator or filter chain

Instantiates with default rules if none available for that type. Use 'decorator', 'filter', or 'validate' for $type.

Arguments

$type: string

Output

Zend_Loader_PluginLoader

Details

visibility: public
final: false
static: false
throws: on invalid type.

getTranslator
jump to class

getTranslator(
          
          )
        
        :
        Zend_Translate_Adapter|null

Retrieve localization translator object

Output

Zend_Translate_Adapter|null

Details

visibility: public
final: false
static: false

getType
jump to class

getType(
          
          )
        
        :
        string

Return element type

Output

string

Details

visibility: public
final: false
static: false

getUnfilteredValue
jump to class

getUnfilteredValue(
          
          )
        
        :
        mixed

Retrieve unfiltered element value

Output

mixed

Details

visibility: public
final: false
static: false

getValidator
jump to class

getValidator(
          string $name
          )
        
        :
        Zend_Validate_Interface|false

Retrieve a single validator by name

Arguments

$name: string

Output

Zend_Validate_Interface|false: False if not found, validator otherwise

Details

visibility: public
final: false
static: false

getValidators
jump to class

getValidators(
          
          )
        
        :
        array

Retrieve all validators

Output

array

Details

visibility: public
final: false
static: false

getValue
jump to class

getValue(
          
          )
        
        :
        mixed

Retrieve filtered element value

Output

mixed

Details

visibility: public
final: false
static: false

getView
jump to class

getView(
          
          )
        
        :
        null|Zend_View_Interface

Retrieve view object

Retrieves from ViewRenderer if none previously set.

Output

null|Zend_View_Interface

Details

visibility: public
final: false
static: false

hasErrors
jump to class

hasErrors(
          
          )
        
        :
        bool

Are there errors registered?

Output

bool

Details

visibility: public
final: false
static: false

hasTranslator
jump to class

hasTranslator(
          
          )
        
        :
        bool

Does this element have its own specific translator?

Output

bool

Details

visibility: public
final: false
static: false

init
jump to class

Initialize object; used by extending classes

Details

visibility: public
final: false
static: false

isArray
jump to class

isArray(
          
          )
        
        :
        bool

Is the element representing an array?

Output

bool

Details

visibility: public
final: false
static: false

isRequired
jump to class

isRequired(
          
          )
        
        :
        bool

Is the element required?

Output

bool

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          mixed $value, mixed $context
              =
              null
          )
        
        :
        boolean

Validate element value

If a translation adapter is registered, any error messages will be translated according to the current locale, using the given error code; if no matching translation is found, the original message will be utilized.

Note: The filtered value is validated.

Arguments

$value: mixed
$context: mixed

Output

boolean

Details

visibility: public
final: false
static: false

loadDefaultDecorators
jump to class

loadDefaultDecorators(
          
          )
        
        :
        Zend_Form_Element

Load default decorators

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

loadDefaultDecoratorsIsDisabled
jump to class

loadDefaultDecoratorsIsDisabled(
          
          )
        
        :
        bool

Should we load the default decorators?

Output

bool

Details

visibility: public
final: false
static: false

markAsError
jump to class

markAsError(
          
          )
        
        :
        Zend_Form_Element

Mark the element as being in a failed validation state

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

removeDecorator
jump to class

removeDecorator(
          string $name
          )
        
        :
        Zend_Form_Element

Remove a single decorator

Arguments

$name: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

removeFilter
jump to class

removeFilter(
          string $name
          )
        
        :
        Zend_Form_Element

Remove a filter by name

Arguments

$name: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

removeValidator
jump to class

removeValidator(
          string $name
          )
        
        :
        bool

Remove a single validator by name

Arguments

$name: string

Output

bool

Details

visibility: public
final: false
static: false

render
jump to class

render(
          Zend_View_Interface $view
              =
              null
          )
        
        :
        string

Render form element

Arguments

$view: Zend_View_Interface

Output

string

Details

visibility: public
final: false
static: false

setAllowEmpty
jump to class

setAllowEmpty(
          bool $flag
          )
        
        :
        Zend_Form_Element

Set 'allow empty' flag

When the allow empty flag is enabled and the required flag is false, the element will validate with empty values.

Arguments

$flag: bool

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setAttrib
jump to class

setAttrib(
          string $name, mixed $value
          )
        
        :
        Zend_Form_Element

Set element attribute

Arguments

$name: string
$value: mixed

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false
throws: for invalid $name values

setAttribs
jump to class

setAttribs(
          array $attribs
          )
        
        :
        Zend_Form_Element

Set multiple attributes at once

Arguments

$attribs: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setAutoInsertNotEmptyValidator
jump to class

setAutoInsertNotEmptyValidator(
          bool $flag
          )
        
        :
        Zend_Form_Element

Set flag indicating whether a NotEmpty validator should be inserted when element is required

Arguments

$flag: bool

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setBelongsTo
jump to class

setBelongsTo(
          string $array
          )
        
        :
        Zend_Form_Element

Set array to which element belongs

Arguments

$array: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setConfig
jump to class

setConfig(
          Zend_Config $config
          )
        
        :
        Zend_Form_Element

Set object state from Zend_Config object

Arguments

$config: Zend_Config

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setDecorators
jump to class

setDecorators(
          array $decorators
          )
        
        :
        Zend_Form_Element

Overwrite all decorators

Arguments

$decorators: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setDescription
jump to class

setDescription(
          string $description
          )
        
        :
        Zend_Form_Element

Set element description

Arguments

$description: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setDisableLoadDefaultDecorators
jump to class

setDisableLoadDefaultDecorators(
          bool $flag
          )
        
        :
        Zend_Form_Element

Set flag to disable loading default decorators

Arguments

$flag: bool

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setDisableTranslator
jump to class

setDisableTranslator(
          bool $flag
          )
        
        :
        Zend_Form_Element

Indicate whether or not translation should be disabled

Arguments

$flag: bool

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setErrorMessageSeparator
jump to class

setErrorMessageSeparator(
          string $separator
          )
        
        :
        Zend_Form_Element

Set errorMessageSeparator

Arguments

$separator: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setErrorMessages
jump to class

setErrorMessages(
          array $messages
          )
        
        :
        Zend_Form_Element

Same as addErrorMessages(), but clears custom error message stack first

Arguments

$messages: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setErrors
jump to class

setErrors(
          array $messages
          )
        
        :
        Zend_Form_Element

Overwrite any previously set error messages and flag as failed validation

Arguments

$messages: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setFilters
jump to class

setFilters(
          array $filters
          )
        
        :
        Zend_Form_Element

Add filters to element, overwriting any already existing

Arguments

$filters: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setIgnore
jump to class

setIgnore(
          bool $flag
          )
        
        :
        Zend_Form_Element

Set ignore flag (used when retrieving values at form level)

Arguments

$flag: bool

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setIsArray
jump to class

setIsArray(
          bool $flag
          )
        
        :
        Zend_Form_Element

Set flag indicating if element represents an array

Arguments

$flag: bool

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setLabel
jump to class

setLabel(
          string $label
          )
        
        :
        Zend_Form_Element

Set element label

Arguments

$label: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setName
jump to class

setName(
          string $name
          )
        
        :
        Zend_Form_Element

Set element name

Arguments

$name: string

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Form_Element

Set object state from options array

Arguments

$options: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setOrder
jump to class

setOrder(
          int $order
          )
        
        :
        Zend_Form_Element

Set element order

Arguments

$order: int

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setPluginLoader
jump to class

setPluginLoader(
          Zend_Loader_PluginLoader_Interface $loader, string $type
          )
        
        :
        Zend_Form_Element

Set plugin loader to use for validator or filter chain

Arguments

$loader: Zend_Loader_PluginLoader_Interface
$type: string
'decorator', 'filter', or 'validate'

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false
throws: on invalid type

setRequired
jump to class

setRequired(
          bool $flag
              =
              true
          )
        
        :
        Zend_Form_Element

Set required flag

Arguments

$flag: bool
Default value is true

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setTranslator
jump to class

setTranslator(
          Zend_Translate|null $translator
              =
              null
          )
        
        :
        Zend_Form_Element

Set translator object for localization

Arguments

$translator: Zend_Translatenull

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setValidators
jump to class

setValidators(
          array $validators
          )
        
        :
        Zend_Form_Element

Set multiple validators, overwriting previous validators

Arguments

$validators: array

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setValue
jump to class

setValue(
          mixed $value
          )
        
        :
        Zend_Form_Element

Set element value

Arguments

$value: mixed

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setView
jump to class

setView(
          Zend_View_Interface $view
              =
              null
          )
        
        :
        Zend_Form_Element

Set view object

Arguments

$view: Zend_View_Interface

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

translatorIsDisabled
jump to class

translatorIsDisabled(
          
          )
        
        :
        bool

Is translation disabled?

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

Form/Element.php

Description

Zend_Form_Elementjump to top

Description

Constants

DECORATORjump to class

Details

FILTERjump to class

Details

VALIDATEjump to class

Details

Properties

$_allowEmptyjump to class

Details

$_autoInsertNotEmptyValidatorjump to class

Details

$_belongsTojump to class

Details

$_decoratorsjump to class

Details

$_descriptionjump to class

Details

$_disableLoadDefaultDecoratorsjump to class

Details

$_errorMessageSeparatorjump to class

Details

$_errorMessagesjump to class

Details

$_errorsjump to class

Details

$_filtersjump to class

Details

$_ignorejump to class

Details

$_isArrayjump to class

Details

$_isErrorjump to class

Details

$_isErrorForcedjump to class

Details

$_isPartialRenderingjump to class

Details

$_labeljump to class

Details

$_loadersjump to class

Details

$_messagesjump to class

Details

$_namejump to class

Details

$_orderjump to class

Details

$_requiredjump to class

Details

$_translatorjump to class

Details

$_translatorDisabledjump to class

Details

$_typejump to class

Details

$_validatorRulesjump to class

Details

$_validatorsjump to class

Details

$_valuejump to class

Details

$_viewjump to class

Details

$helperjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

__getjump to class

Zend_Form_Element
jump to top

DECORATOR
jump to class

FILTER
jump to class

VALIDATE
jump to class

$_allowEmpty
jump to class

$_autoInsertNotEmptyValidator
jump to class

$_belongsTo
jump to class

$_decorators
jump to class

$_description
jump to class

$_disableLoadDefaultDecorators
jump to class

$_errorMessageSeparator
jump to class

$_errorMessages
jump to class

$_errors
jump to class

$_filters
jump to class

$_ignore
jump to class

$_isArray
jump to class

$_isError
jump to class

$_isErrorForced
jump to class

$_isPartialRendering
jump to class

$_label
jump to class

$_loaders
jump to class

$_messages
jump to class

$_name
jump to class

$_order
jump to class

$_required
jump to class

$_translator
jump to class

$_translatorDisabled
jump to class

$_type
jump to class

$_validatorRules
jump to class

$_validators
jump to class

$_value
jump to class

$_view
jump to class

$helper
jump to class

__call
jump to class

__construct
jump to class

__get
jump to class

__set
jump to class

__toString
jump to class

_filterValue
jump to class

_getDecorator
jump to class

_getErrorMessages
jump to class

_hasErrorMessages
jump to class

_loadDecorator
jump to class

_loadFilter
jump to class

_loadValidator
jump to class

addDecorator
jump to class

addDecorators
jump to class

addError
jump to class

addErrorMessage
jump to class

addErrorMessages
jump to class

addErrors
jump to class

addFilter
jump to class

addFilters
jump to class

addPrefixPath
jump to class