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

bool
$_autoInsertNotEmptyValidator= 'true'
Flag indicating whether or not to insert NotEmpty validator when element is required
true
Details
bool
$_disableLoadDefaultDecorators= 'false'
Should we disable loading the default decorators?
false
Details
string
$_errorMessageSeparator= ''; ''
Separator to use when concatenating aggregate error messages (for elements having array values)
'; '
Details
bool
$_ignore= 'false'
Ignore flag (used when retrieving values at form level)
false
Details
bool
$_isError= 'false'
Is the error marked as in an invalid state?
false
Details
bool
$_isErrorForced= 'false'
Has the element been manually marked as invalid?
false
Details
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.
false
Details
array
$_loaders= 'array()'
Plugin loaders for filter and validator chains
array()
Details
array
$_messages= 'array()'
Formatted validation error messages
array()
Details
array
$_validatorRules= 'array()'
Array of un-initialized validators
array()
Details
array
$_validators= 'array()'
Array of initialized validators
Validatorsarray()
Details
__call(
string $method, array $args
)
:
string
Overloading: allow rendering specific decorators
Call renderDecoratorName() to render a specific decorator.
Name | Type | Description |
---|---|---|
$method | string | |
$args | array |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Exception | for invalid decorator or invalid method call |

__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
Name | Type | Description |
---|---|---|
$spec | string|array|\Zend_Config | |
$options | array|\Zend_Config |
Exception | Description |
---|---|
\Zend_Form_Exception | if no element name after initialization |

__get(
string $key
)
:
mixed
Overloading: retrieve object property
Prevents access to properties beginning with '_'.
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

__set(
string $key, mixed $value
)
:
\voide
Overloading: set object property
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\voide |

__toString(
)
:
string
String representation of form element
Proxies to {@link render()}.
Type | Description |
---|---|
string |

_filterValue(
string $value, string $key
)
:
void
Filter a value
Name | Type | Description |
---|---|---|
$value | string | |
$key | string |

_getDecorator(
string $name, null|array $options
)
:
\Zend_Form_Decorator_Interface
Instantiate a decorator based on class name or class name fragment
Name | Type | Description |
---|---|---|
$name | string | |
$options | null|array |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |

_getErrorMessages(
)
:
array
Retrieve error messages and perform translation and value substitution
Type | Description |
---|---|
array |

_hasErrorMessages(
)
:
bool
Are there custom error messages registered?
Type | Description |
---|---|
bool |

_loadDecorator(
array $decorator, mixed $name
)
:
\Zend_Form_Decorator_Interface
Lazy-load a decorator
Name | Type | Description |
---|---|---|
$decorator | array | Decorator type and options |
$name | mixed | Decorator name or alias |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |

_loadValidator(
array $validator
)
:
\Zend_Validate_Interface
Lazy-load a validator
Name | Type | Description |
---|---|---|
$validator | array | Validator definition |
Type | Description |
---|---|
\Zend_Validate_Interface |

addDecorator(
string|\Zend_Form_Decorator_Interface $decorator, array|\Zend_Config $options
=
null
)
:
\Zend_Form_Element
Add a decorator for rendering the element
Name | Type | Description |
---|---|---|
$decorator | string|\Zend_Form_Decorator_Interface | |
$options | array|\Zend_Config | Options with which to initialize decorator |
Type | Description |
---|---|
\Zend_Form_Element |

addError(
string $message
)
:
\Zend_Form_Element
Add an error message and mark element as failed validation

addErrorMessage(
string $message
)
:
\Zend_Form_Element
Add a custom error message to return in the event of failed validation

addErrorMessages(
array $messages
)
:
\Zend_Form_Element
Add multiple custom error messages to return in the event of failed validation

addErrors(
array $messages
)
:
\Zend_Form_Element
Add multiple error messages and flag element as failed validation

addFilter(
string|\Zend_Filter_Interface $filter, $options
=
array()
)
:
\Zend_Form_Element
Add a filter to the element
Name | Type | Description |
---|---|---|
$filter | string|\Zend_Filter_Interface | |
$options |
Type | Description |
---|---|
\Zend_Form_Element |

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.
Name | Type | Description |
---|---|---|
$prefix | string | |
$path | string | |
$type | string |
Type | Description |
---|---|
\Zend_Form_Element |
Exception | Description |
---|---|
\Zend_Form_Exception | for invalid type |

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.
Name | Type | Description |
---|---|---|
$validator | string|\Zend_Validate_Interface | |
$breakChainOnFailure | bool | |
$options | array |
Type | Description |
---|---|
\Zend_Form_Element |
Exception | Description |
---|---|
\Zend_Form_Exception | if invalid validator type |

autoInsertNotEmptyValidator(
)
:
bool
Get flag indicating whether a NotEmpty validator should be inserted when element is required
Type | Description |
---|---|
bool |

clearDecorators(
)
:
\Zend_Form_Element
Clear all decorators
Type | Description |
---|---|
\Zend_Form_Element |

clearErrorMessages(
)
:
\Zend_Form_Element
Clear custom error messages stack
Type | Description |
---|---|
\Zend_Form_Element |

clearValidators(
)
:
\Zend_Form_Element
Clear all validators
Type | Description |
---|---|
\Zend_Form_Element |

filterName(
string $value, bool $allowBrackets
=
false
)
:
string
Filter a name to only allow valid variable characters
Name | Type | Description |
---|---|---|
$value | string | |
$allowBrackets | bool |
Type | Description |
---|---|
string |

getAttrib(
string $name
)
:
string
Retrieve element attribute
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string |

getDecorator(
string $name
)
:
false|\Zend_Form_Decorator_Abstract
Retrieve a registered decorator
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
false|\Zend_Form_Decorator_Abstract |

getFullyQualifiedName(
)
:
string
Get fully qualified name
Places name as subitem of array and/or appends brackets.
Type | Description |
---|---|
string |

getIgnore(
)
:
bool
Get ignore flag (used when retrieving values at form level)
Type | Description |
---|---|
bool |

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.
Name | Type | Description |
---|---|---|
$type | string |
Type | Description |
---|---|
\Zend_Loader_PluginLoader |
Exception | Description |
---|---|
\Zend_Loader_Exception | on invalid type. |

getTranslator(
)
:
\Zend_Translate_Adapter|null
Retrieve localization translator object
Type | Description |
---|---|
\Zend_Translate_Adapter|null |

getValidator(
string $name
)
:
\Zend_Validate_Interface|false
Retrieve a single validator by name
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Validate_Interface|false | False if not found, validator otherwise |

getView(
)
:
null|\Zend_View_Interface
Retrieve view object
Retrieves from ViewRenderer if none previously set.
Type | Description |
---|---|
null|\Zend_View_Interface |

hasTranslator(
)
:
bool
Does this element have its own specific translator?
Type | Description |
---|---|
bool |

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.
Name | Type | Description |
---|---|---|
$value | mixed | |
$context | mixed |
Type | Description |
---|---|
boolean |

loadDefaultDecorators(
)
:
\Zend_Form_Element
Load default decorators
Type | Description |
---|---|
\Zend_Form_Element |

loadDefaultDecoratorsIsDisabled(
)
:
bool
Should we load the default decorators?
Type | Description |
---|---|
bool |

markAsError(
)
:
\Zend_Form_Element
Mark the element as being in a failed validation state
Type | Description |
---|---|
\Zend_Form_Element |

removeValidator(
string $name
)
:
bool
Remove a single validator by name
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
bool |

resolveElementId(
\Zend_Form_Decorator_Interface $decorator
)
:
string
Used to resolve and return an element ID
Passed to the HtmlTag decorator as a callback in order to provide an ID.
Name | Type | Description |
---|---|---|
$decorator | \Zend_Form_Decorator_Interface |
Type | Description |
---|---|
string |

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.
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Element |

setAttrib(
string $name, mixed $value
)
:
\Zend_Form_Element
Set element attribute
Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Element |
Exception | Description |
---|---|
\Zend_Form_Exception | for invalid $name values |

setAutoInsertNotEmptyValidator(
bool $flag
)
:
\Zend_Form_Element
Set flag indicating whether a NotEmpty validator should be inserted when element is required

setDisableLoadDefaultDecorators(
bool $flag
)
:
\Zend_Form_Element
Set flag to disable loading default decorators

setDisableTranslator(
bool $flag
)
:
\Zend_Form_Element
Indicate whether or not translation should be disabled

setErrorMessages(
array $messages
)
:
\Zend_Form_Element
Same as addErrorMessages(), but clears custom error message stack first

setErrors(
array $messages
)
:
\Zend_Form_Element
Overwrite any previously set error messages and flag as failed validation

setFilters(
array $filters
)
:
\Zend_Form_Element
Add filters to element, overwriting any already existing

setIgnore(
bool $flag
)
:
\Zend_Form_Element
Set ignore flag (used when retrieving values at form level)

setPluginLoader(
\Zend_Loader_PluginLoader_Interface $loader, string $type
)
:
\Zend_Form_Element
Set plugin loader to use for validator or filter chain
Name | Type | Description |
---|---|---|
$loader | \Zend_Loader_PluginLoader_Interface | |
$type | string | 'decorator', 'filter', or 'validate' |
Type | Description |
---|---|
\Zend_Form_Element |
Exception | Description |
---|---|
\Zend_Form_Exception | on invalid type |

setRequired(
bool $flag
=
true
)
:
\Zend_Form_Element
Set required flag
Name | Type | Description |
---|---|---|
$flag | bool | Default value is true |
Type | Description |
---|---|
\Zend_Form_Element |

setTranslator(
\Zend_Translate|null $translator
=
null
)
:
\Zend_Form_Element
Set translator object for localization
Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|null |
Type | Description |
---|---|
\Zend_Form_Element |

setValidators(
array $validators
)
:
\Zend_Form_Element
Set multiple validators, overwriting previous validators

setView(
\Zend_View_Interface $view
=
null
)
:
\Zend_Form_Element
Set view object
Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
\Zend_Form_Element |