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.
CSRF form protection

__call(
string $method, array $args
)
:
string
Overloading: allow rendering specific decorators
Inherited from: \Zend_Form_Element::__call()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
Creates session namespace for CSRF token, and adds validator for CSRF token.
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
Inherited from: \Zend_Form_Element::__get()Prevents access to properties beginning with '_'.
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

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

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

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

_generateHash(
)
:
void
Generate CSRF token
Generates CSRF token and stores both in {@link $_hash} and element value.

_getDecorator(
string $name, null|array $options
)
:
\Zend_Form_Decorator_Interface
Instantiate a decorator based on class name or class name fragment
Inherited from: \Zend_Form_Element::_getDecorator()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
Inherited from: \Zend_Form_Element::_getErrorMessages()Type | Description |
---|---|
array |

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

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

_loadFilter(
array $filter
)
:
\Zend_Filter_Interface
Lazy-load a filter
Inherited from: \Zend_Form_Element::_loadFilter()
_loadValidator(
array $validator
)
:
\Zend_Validate_Interface
Lazy-load a validator
Inherited from: \Zend_Form_Element::_loadValidator()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
Inherited from: \Zend_Form_Element::addDecorator()Name | Type | Description |
---|---|---|
$decorator | string|\Zend_Form_Decorator_Interface | |
$options | array|\Zend_Config | Options with which to initialize decorator |
Type | Description |
---|---|
\Zend_Form_Element |

addDecorators(
array $decorators
)
:
\Zend_Form_Element
Add many decorators at once
Inherited from: \Zend_Form_Element::addDecorators()
addError(
string $message
)
:
\Zend_Form_Element
Add an error message and mark element as failed validation
Inherited from: \Zend_Form_Element::addError()
addErrorMessage(
string $message
)
:
\Zend_Form_Element
Add a custom error message to return in the event of failed validation
Inherited from: \Zend_Form_Element::addErrorMessage()
addErrorMessages(
array $messages
)
:
\Zend_Form_Element
Add multiple custom error messages to return in the event of failed validation
Inherited from: \Zend_Form_Element::addErrorMessages()
addErrors(
array $messages
)
:
\Zend_Form_Element
Add multiple error messages and flag element as failed validation
Inherited from: \Zend_Form_Element::addErrors()
addFilter(
string|\Zend_Filter_Interface $filter, $options
=
array
)
:
\Zend_Form_Element
Add a filter to the element
Inherited from: \Zend_Form_Element::addFilter()Name | Type | Description |
---|---|---|
$filter | string|\Zend_Filter_Interface | |
$options |
Type | Description |
---|---|
\Zend_Form_Element |

addFilters(
array $filters
)
:
\Zend_Form_Element
Add filters to element
Inherited from: \Zend_Form_Element::addFilters()
addPrefixPath(
string $prefix, string $path, string $type
=
null
)
:
\Zend_Form_Element
Add prefix path for plugin loader
Inherited from: \Zend_Form_Element::addPrefixPath()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 |

addPrefixPaths(
array $spec
)
:
\Zend_Form_Element
Add many prefix paths at once
Inherited from: \Zend_Form_Element::addPrefixPaths()
addValidator(
string|\Zend_Validate_Interface $validator, bool $breakChainOnFailure
=
false, array $options
=
array
)
:
\Zend_Form_Element
Add validator to validation chain
Inherited from: \Zend_Form_Element::addValidator()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 |

addValidators(
array $validators
)
:
\Zend_Form_Element
Add multiple validators
Inherited from: \Zend_Form_Element::addValidators()
autoInsertNotEmptyValidator(
)
:
bool
Get flag indicating whether a NotEmpty validator should be inserted when element is required
Inherited from: \Zend_Form_Element::autoInsertNotEmptyValidator()Type | Description |
---|---|
bool |

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

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

clearFilters(
)
:
\Zend_Form_Element
Clear all filters
Inherited from: \Zend_Form_Element::clearFilters()Type | Description |
---|---|
\Zend_Form_Element |

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

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

getAllowEmpty(
)
:
bool
Get 'allow empty' flag
Inherited from: \Zend_Form_Element::getAllowEmpty()Type | Description |
---|---|
bool |

getAttrib(
string $name
)
:
string
Retrieve element attribute
Inherited from: \Zend_Form_Element::getAttrib()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string |

getAttribs(
)
:
array
Return all attributes
Inherited from: \Zend_Form_Element::getAttribs()Type | Description |
---|---|
array |

getBelongsTo(
)
:
string
Return array name to which element belongs
Inherited from: \Zend_Form_Element::getBelongsTo()Type | Description |
---|---|
string |

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

getDecorators(
)
:
array
Retrieve all decorators
Inherited from: \Zend_Form_Element::getDecorators()Type | Description |
---|---|
array |

getDescription(
)
:
string
Retrieve element description
Inherited from: \Zend_Form_Element::getDescription()Type | Description |
---|---|
string |

getErrorMessageSeparator(
)
:
string
Get errorMessageSeparator
Inherited from: \Zend_Form_Element::getErrorMessageSeparator()Type | Description |
---|---|
string |

getErrorMessages(
)
:
array
Retrieve custom error messages
Inherited from: \Zend_Form_Element::getErrorMessages()Type | Description |
---|---|
array |

getErrors(
)
:
array
Retrieve validator chain errors
Inherited from: \Zend_Form_Element::getErrors()Type | Description |
---|---|
array |

getFilter(
string $name
)
:
\Zend_Filter_Interface
Retrieve a single filter by name
Inherited from: \Zend_Form_Element::getFilter()
getFilters(
)
:
array
Get all filters
Inherited from: \Zend_Form_Element::getFilters()Type | Description |
---|---|
array |

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

getHash(
)
:
string
Retrieve CSRF token
If no CSRF token currently exists, generates one.
Type | Description |
---|---|
string |

getId(
)
:
string
Get element id
Inherited from: \Zend_Form_Element::getId()Type | Description |
---|---|
string |

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

getMessages(
)
:
array
Retrieve error messages
Inherited from: \Zend_Form_Element::getMessages()If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.
Type | Description |
---|---|
array |

getName(
)
:
string
Return element name
Inherited from: \Zend_Form_Element::getName()Type | Description |
---|---|
string |

getOrder(
)
:
int
Retrieve element order
Inherited from: \Zend_Form_Element::getOrder()Type | Description |
---|---|
int |

getPluginLoader(
string $type
)
:
\Zend_Loader_PluginLoader
Retrieve plugin loader for validator or filter chain
Inherited from: \Zend_Form_Element::getPluginLoader()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. |

getSession(
)
:
\Zend_Session_Namespace
Get session object
Instantiate session object if none currently exists
Type | Description |
---|---|
\Zend_Session_Namespace |

getSessionName(
)
:
string
Get session namespace for CSRF token
Generates a session namespace based on salt, element name, and class.
Type | Description |
---|---|
string |

getTranslator(
)
:
\Zend_Translate_Adapter|null
Retrieve localization translator object
Inherited from: \Zend_Form_Element::getTranslator()Type | Description |
---|---|
\Zend_Translate_Adapternull |

getType(
)
:
string
Return element type
Inherited from: \Zend_Form_Element::getType()Type | Description |
---|---|
string |

getUnfilteredValue(
)
:
mixed
Retrieve unfiltered element value
Inherited from: \Zend_Form_Element::getUnfilteredValue()Type | Description |
---|---|
mixed |

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

getValidators(
)
:
array
Retrieve all validators
Inherited from: \Zend_Form_Element::getValidators()Type | Description |
---|---|
array |

getValue(
)
:
mixed
Retrieve filtered element value
Inherited from: \Zend_Form_Element::getValue()Type | Description |
---|---|
mixed |

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

hasErrors(
)
:
bool
Are there errors registered?
Inherited from: \Zend_Form_Element::hasErrors()Type | Description |
---|---|
bool |

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

init(
)
:
void
Initialize object; used by extending classes
Inherited from: \Zend_Form_Element::init()
initCsrfValidator(
)
:
\Zend_Form_Element_Hash
Initialize CSRF validator
Creates Session namespace, and initializes CSRF token in session. Additionally, adds validator for validating CSRF token.
Type | Description |
---|---|
\Zend_Form_Element_Hash |

isArray(
)
:
bool
Is the element representing an array?
Inherited from: \Zend_Form_Element::isArray()Type | Description |
---|---|
bool |

isRequired(
)
:
bool
Is the element required?
Inherited from: \Zend_Form_Element::isRequired()Type | Description |
---|---|
bool |

isValid(
mixed $value, mixed $context
=
null
)
:
boolean
Validate element value
Inherited from: \Zend_Form_Element::isValid()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 |
Exception | Description |
---|---|
\Zend_Validate_Exception | If validation of $value is impossible |

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

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

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

removeDecorator(
string $name
)
:
\Zend_Form_Element
Remove a single decorator
Inherited from: \Zend_Form_Element::removeDecorator()
removeFilter(
string $name
)
:
\Zend_Form_Element
Remove a filter by name
Inherited from: \Zend_Form_Element::removeFilter()
removeValidator(
string $name
)
:
bool
Remove a single validator by name
Inherited from: \Zend_Form_Element::removeValidator()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
bool |

resolveElementId(
\Zend_Form_Decorator_Interface $decorator
)
:
string
Used to resolve and return an element ID
Inherited from: \Zend_Form_Element::resolveElementId()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
Inherited from: \Zend_Form_Element::setAllowEmpty()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
Inherited from: \Zend_Form_Element::setAttrib()Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Element |
Exception | Description |
---|---|
\Zend_Form_Exception | for invalid $name values |

setAttribs(
array $attribs
)
:
\Zend_Form_Element
Set multiple attributes at once
Inherited from: \Zend_Form_Element::setAttribs()
setAutoInsertNotEmptyValidator(
bool $flag
)
:
\Zend_Form_Element
Set flag indicating whether a NotEmpty validator should be inserted when element is required
Inherited from: \Zend_Form_Element::setAutoInsertNotEmptyValidator()
setBelongsTo(
string $array
)
:
\Zend_Form_Element
Set array to which element belongs
Inherited from: \Zend_Form_Element::setBelongsTo()
setConfig(
\Zend_Config $config
)
:
\Zend_Form_Element
Set object state from Zend_Config object
Inherited from: \Zend_Form_Element::setConfig()
setDecorators(
array $decorators
)
:
\Zend_Form_Element
Overwrite all decorators
Inherited from: \Zend_Form_Element::setDecorators()
setDescription(
string $description
)
:
\Zend_Form_Element
Set element description
Inherited from: \Zend_Form_Element::setDescription()
setDisableLoadDefaultDecorators(
bool $flag
)
:
\Zend_Form_Element
Set flag to disable loading default decorators
Inherited from: \Zend_Form_Element::setDisableLoadDefaultDecorators()
setDisableTranslator(
bool $flag
)
:
\Zend_Form_Element
Indicate whether or not translation should be disabled
Inherited from: \Zend_Form_Element::setDisableTranslator()
setErrorMessageSeparator(
string $separator
)
:
\Zend_Form_Element
Set errorMessageSeparator
Inherited from: \Zend_Form_Element::setErrorMessageSeparator()
setErrorMessages(
array $messages
)
:
\Zend_Form_Element
Same as addErrorMessages(), but clears custom error message stack first
Inherited from: \Zend_Form_Element::setErrorMessages()
setErrors(
array $messages
)
:
\Zend_Form_Element
Overwrite any previously set error messages and flag as failed validation
Inherited from: \Zend_Form_Element::setErrors()
setFilters(
array $filters
)
:
\Zend_Form_Element
Add filters to element, overwriting any already existing
Inherited from: \Zend_Form_Element::setFilters()
setIgnore(
bool $flag
)
:
\Zend_Form_Element
Set ignore flag (used when retrieving values at form level)
Inherited from: \Zend_Form_Element::setIgnore()
setIsArray(
bool $flag
)
:
\Zend_Form_Element
Set flag indicating if element represents an array
Inherited from: \Zend_Form_Element::setIsArray()
setLabel(
string $label
)
:
\Zend_Form_Element
Set element label
Inherited from: \Zend_Form_Element::setLabel()
setName(
string $name
)
:
\Zend_Form_Element
Set element name
Inherited from: \Zend_Form_Element::setName()
setOptions(
array $options
)
:
\Zend_Form_Element
Set object state from options array
Inherited from: \Zend_Form_Element::setOptions()
setOrder(
int $order
)
:
\Zend_Form_Element
Set element order
Inherited from: \Zend_Form_Element::setOrder()
setPluginLoader(
\Zend_Loader_PluginLoader_Interface $loader, string $type
)
:
\Zend_Form_Element
Set plugin loader to use for validator or filter chain
Inherited from: \Zend_Form_Element::setPluginLoader()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
Inherited from: \Zend_Form_Element::setRequired()Name | Type | Description |
---|---|---|
$flag | bool | Default value is true |
Type | Description |
---|---|
\Zend_Form_Element |

setSession(
\Zend_Session_Namespace $session
)
:
\Zend_Form_Element_Hash
Set session object
Name | Type | Description |
---|---|---|
$session | \Zend_Session_Namespace |
Type | Description |
---|---|
\Zend_Form_Element_Hash |

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

setValidators(
array $validators
)
:
\Zend_Form_Element
Set multiple validators, overwriting previous validators
Inherited from: \Zend_Form_Element::setValidators()
setValue(
mixed $value
)
:
\Zend_Form_Element
Set element value
Inherited from: \Zend_Form_Element::setValue()
setView(
\Zend_View_Interface $view
=
null
)
:
\Zend_Form_Element
Set view object
Inherited from: \Zend_Form_Element::setView()Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
\Zend_Form_Element |

translatorIsDisabled(
)
:
bool
Is translation disabled?
Inherited from: \Zend_Form_Element::translatorIsDisabled()Type | Description |
---|---|
bool |