Form/Element/Hash.php

Show:

inherited

Classes
- \Zend_Form_Element_Hash

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Form
Subpackage: Element

\Zend_Form_Element_Hash
jump to top

Package: Zend\Form\Element

CSRF form protection

Parent(s): \Zend_Form_Element_Xhtml < \Zend_Form_Element
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: Hash.php 24593 2012-01-05 20:35:02Z matthew $

Constants

 
                DECORATOR
                = 'DECORATOR'

inherited

Element Constants

Inherited from: \Zend_Form_Element::DECORATOR \Zend_Form_Element_Xhtml::DECORATOR

Inherited_from: \Zend_Form_Element::DECORATOR
Inherited_from: \Zend_Form_Element_Xhtml::DECORATOR

 
                FILTER
                = 'FILTER'

inheritedInherited from: \Zend_Form_Element::FILTER \Zend_Form_Element_Xhtml::FILTER

Inherited_from: \Zend_Form_Element::FILTER
Inherited_from: \Zend_Form_Element_Xhtml::FILTER

 
                VALIDATE
                = 'VALIDATE'

inheritedInherited from: \Zend_Form_Element::VALIDATE \Zend_Form_Element_Xhtml::VALIDATE

Inherited_from: \Zend_Form_Element::VALIDATE
Inherited_from: \Zend_Form_Element_Xhtml::VALIDATE

Properties

bool $_allowEmpty = true

inherited

'Allow empty' flag

Inherited from: \Zend_Form_Element::$$_allowEmpty \Zend_Form_Element_Xhtml::$$_allowEmpty

Default valuetrueDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_allowEmpty
Inherited_from: \Zend_Form_Element_Xhtml::$$_allowEmpty

bool $_autoInsertNotEmptyValidator = true

inherited

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

Inherited from: \Zend_Form_Element::$$_autoInsertNotEmptyValidator \Zend_Form_Element_Xhtml::$$_autoInsertNotEmptyValidator

Default valuetrueDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_autoInsertNotEmptyValidator
Inherited_from: \Zend_Form_Element_Xhtml::$$_autoInsertNotEmptyValidator

string $_belongsTo

inherited

Array to which element belongs

Inherited from: \Zend_Form_Element::$$_belongsTo \Zend_Form_Element_Xhtml::$$_belongsTo

Details

Type: string
Inherited_from: \Zend_Form_Element::$$_belongsTo
Inherited_from: \Zend_Form_Element_Xhtml::$$_belongsTo

array $_decorators = array()

inherited

Element decorators

Inherited from: \Zend_Form_Element::$$_decorators \Zend_Form_Element_Xhtml::$$_decorators

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Element::$$_decorators
Inherited_from: \Zend_Form_Element_Xhtml::$$_decorators

string $_description

inherited

Element description

Inherited from: \Zend_Form_Element::$$_description \Zend_Form_Element_Xhtml::$$_description

Details

Type: string
Inherited_from: \Zend_Form_Element::$$_description
Inherited_from: \Zend_Form_Element_Xhtml::$$_description

bool $_disableLoadDefaultDecorators = false

inherited

Should we disable loading the default decorators?

Inherited from: \Zend_Form_Element::$$_disableLoadDefaultDecorators \Zend_Form_Element_Xhtml::$$_disableLoadDefaultDecorators

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_disableLoadDefaultDecorators
Inherited_from: \Zend_Form_Element_Xhtml::$$_disableLoadDefaultDecorators

string $_errorMessageSeparator = '; '

inherited

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

Inherited from: \Zend_Form_Element::$$_errorMessageSeparator \Zend_Form_Element_Xhtml::$$_errorMessageSeparator

Default value'; 'Details

Type: string
Inherited_from: \Zend_Form_Element::$$_errorMessageSeparator
Inherited_from: \Zend_Form_Element_Xhtml::$$_errorMessageSeparator

array $_errorMessages = array()

inherited

Custom error messages

Inherited from: \Zend_Form_Element::$$_errorMessages \Zend_Form_Element_Xhtml::$$_errorMessages

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Element::$$_errorMessages
Inherited_from: \Zend_Form_Element_Xhtml::$$_errorMessages

array $_errors = array()

inherited

Validation errors

Inherited from: \Zend_Form_Element::$$_errors \Zend_Form_Element_Xhtml::$$_errors

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Element::$$_errors
Inherited_from: \Zend_Form_Element_Xhtml::$$_errors

array $_filters = array()

inherited

Element filters

Inherited from: \Zend_Form_Element::$$_filters \Zend_Form_Element_Xhtml::$$_filters

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Element::$$_filters
Inherited_from: \Zend_Form_Element_Xhtml::$$_filters

mixed $_hash

Actual hash used.

Details

Type: mixed

bool $_ignore = false

inherited

Ignore flag (used when retrieving values at form level)

Inherited from: \Zend_Form_Element::$$_ignore \Zend_Form_Element_Xhtml::$$_ignore

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_ignore
Inherited_from: \Zend_Form_Element_Xhtml::$$_ignore

bool $_isArray = false

inherited

Does the element represent an array?

Inherited from: \Zend_Form_Element::$$_isArray \Zend_Form_Element_Xhtml::$$_isArray

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_isArray
Inherited_from: \Zend_Form_Element_Xhtml::$$_isArray

bool $_isError = false

inherited

Is the error marked as in an invalid state?

Inherited from: \Zend_Form_Element::$$_isError \Zend_Form_Element_Xhtml::$$_isError

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_isError
Inherited_from: \Zend_Form_Element_Xhtml::$$_isError

bool $_isErrorForced = false

inherited

Has the element been manually marked as invalid?

Inherited from: \Zend_Form_Element::$$_isErrorForced \Zend_Form_Element_Xhtml::$$_isErrorForced

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_isErrorForced
Inherited_from: \Zend_Form_Element_Xhtml::$$_isErrorForced

bool $_isPartialRendering = false

inherited

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

Inherited from: \Zend_Form_Element::$$_isPartialRendering \Zend_Form_Element_Xhtml::$$_isPartialRendering

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

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_isPartialRendering
Inherited_from: \Zend_Form_Element_Xhtml::$$_isPartialRendering

string $_label

inherited

Element label

Inherited from: \Zend_Form_Element::$$_label \Zend_Form_Element_Xhtml::$$_label

Details

Type: string
Inherited_from: \Zend_Form_Element::$$_label
Inherited_from: \Zend_Form_Element_Xhtml::$$_label

array $_loaders = array()

inherited

Plugin loaders for filter and validator chains

Inherited from: \Zend_Form_Element::$$_loaders \Zend_Form_Element_Xhtml::$$_loaders

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Element::$$_loaders
Inherited_from: \Zend_Form_Element_Xhtml::$$_loaders

array $_messages = array()

inherited

Formatted validation error messages

Inherited from: \Zend_Form_Element::$$_messages \Zend_Form_Element_Xhtml::$$_messages

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Element::$$_messages
Inherited_from: \Zend_Form_Element_Xhtml::$$_messages

string $_name

inherited

Element name

Inherited from: \Zend_Form_Element::$$_name \Zend_Form_Element_Xhtml::$$_name

Details

Type: string
Inherited_from: \Zend_Form_Element::$$_name
Inherited_from: \Zend_Form_Element_Xhtml::$$_name

int $_order

inherited

Order of element

Inherited from: \Zend_Form_Element::$$_order \Zend_Form_Element_Xhtml::$$_order

Details

Type: int
Inherited_from: \Zend_Form_Element::$$_order
Inherited_from: \Zend_Form_Element_Xhtml::$$_order

bool $_required = false

inherited

Required flag

Inherited from: \Zend_Form_Element::$$_required \Zend_Form_Element_Xhtml::$$_required

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_required
Inherited_from: \Zend_Form_Element_Xhtml::$$_required

string $_salt = 'salt'

Salt for CSRF token

Default value'salt'Details

Type: string

\Zend_Session_Namespace $_session

Details

Type: \Zend_Session_Namespace

int $_timeout = 300

TTL for CSRF token

Default value300Details

Type: int

\Zend_Translate $_translator

inherited

Inherited from: \Zend_Form_Element::$$_translator \Zend_Form_Element_Xhtml::$$_translator

Details

Type: \Zend_Translate
Inherited_from: \Zend_Form_Element::$$_translator
Inherited_from: \Zend_Form_Element_Xhtml::$$_translator

bool $_translatorDisabled = false

inherited

Is translation disabled?

Inherited from: \Zend_Form_Element::$$_translatorDisabled \Zend_Form_Element_Xhtml::$$_translatorDisabled

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_Element::$$_translatorDisabled
Inherited_from: \Zend_Form_Element_Xhtml::$$_translatorDisabled

string $_type

inherited

Element type

Inherited from: \Zend_Form_Element::$$_type \Zend_Form_Element_Xhtml::$$_type

Details

Type: string
Inherited_from: \Zend_Form_Element::$$_type
Inherited_from: \Zend_Form_Element_Xhtml::$$_type

array $_validatorRules = array()

inherited

Array of un-initialized validators

Inherited from: \Zend_Form_Element::$$_validatorRules \Zend_Form_Element_Xhtml::$$_validatorRules

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Element::$$_validatorRules
Inherited_from: \Zend_Form_Element_Xhtml::$$_validatorRules

array $_validators = array()

inherited

Array of initialized validators

Inherited from: \Zend_Form_Element::$$_validators \Zend_Form_Element_Xhtml::$$_validators

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Element::$$_validators
Inherited_from: \Zend_Form_Element_Xhtml::$$_validators

mixed $_value

inherited

Element value

Inherited from: \Zend_Form_Element::$$_value \Zend_Form_Element_Xhtml::$$_value

Details

Type: mixed
Inherited_from: \Zend_Form_Element::$$_value
Inherited_from: \Zend_Form_Element_Xhtml::$$_value

\Zend_View_Interface $_view

inherited

Inherited from: \Zend_Form_Element::$$_view \Zend_Form_Element_Xhtml::$$_view

Details

Type: \Zend_View_Interface
Inherited_from: \Zend_Form_Element::$$_view
Inherited_from: \Zend_Form_Element_Xhtml::$$_view

string $helper = 'formHidden'

Use formHidden view helper by default

Default value'formHidden'Details

Type: string

Methods

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

inherited

Overloading: allow rendering specific decorators

Inherited from: \Zend_Form_Element::__call()\Zend_Form_Element_Xhtml::__call()

Call renderDecoratorName() to render a specific decorator.

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
string

Throws

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.

Parameters

Name	Type	Description
$spec	string \| array \| \Zend_Config
$options	array \| \Zend_Config

Throws

Exception	Description
\Zend_Form_Exception	if no element name after initialization

__get(string $key) : mixed

inherited

Overloading: retrieve object property

Inherited from: \Zend_Form_Element::__get()\Zend_Form_Element_Xhtml::__get()

Prevents access to properties beginning with '_'.

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

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

inherited

Overloading: set object property

Inherited from: \Zend_Form_Element::__set()\Zend_Form_Element_Xhtml::__set()

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\voide

__toString() : string

inherited

String representation of form element

Inherited from: \Zend_Form_Element::__toString()\Zend_Form_Element_Xhtml::__toString()

Proxies to render().

Returns

Type	Description
string

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

inherited

Filter a value

Inherited from: \Zend_Form_Element::_filterValue()\Zend_Form_Element_Xhtml::_filterValue()

Parameters

Name	Type	Description
$value	string
$key	string

_generateHash() : void

Generate CSRF token

Generates CSRF token and stores both in $_hash and element value.

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

inherited

Instantiate a decorator based on class name or class name fragment

Inherited from: \Zend_Form_Element::_getDecorator()\Zend_Form_Element_Xhtml::_getDecorator()

Parameters

Name	Type	Description
$name	string
$options	null \| array

Returns

Type	Description
\Zend_Form_Decorator_Interface

_getErrorMessages() : array

inherited

Retrieve error messages and perform translation and value substitution

Inherited from: \Zend_Form_Element::_getErrorMessages()\Zend_Form_Element_Xhtml::_getErrorMessages()

Returns

Type	Description
array

_hasErrorMessages() : bool

inherited

Are there custom error messages registered?

Inherited from: \Zend_Form_Element::_hasErrorMessages()\Zend_Form_Element_Xhtml::_hasErrorMessages()

Returns

Type	Description
bool

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

inherited

Lazy-load a decorator

Inherited from: \Zend_Form_Element::_loadDecorator()\Zend_Form_Element_Xhtml::_loadDecorator()

Parameters

Name	Type	Description
$decorator	array	Decorator type and options
$name	mixed	Decorator name or alias

Returns

Type	Description
\Zend_Form_Decorator_Interface

_loadFilter(array $filter) : \Zend_Filter_Interface

inherited

Lazy-load a filter

Inherited from: \Zend_Form_Element::_loadFilter()\Zend_Form_Element_Xhtml::_loadFilter()

Parameters

Name	Type	Description
$filter	array

Returns

Type	Description
\Zend_Filter_Interface

_loadValidator(array $validator) : \Zend_Validate_Interface

inherited

Lazy-load a validator

Inherited from: \Zend_Form_Element::_loadValidator()\Zend_Form_Element_Xhtml::_loadValidator()

Parameters

Name	Type	Description
$validator	array	Validator definition

Returns

Type	Description
\Zend_Validate_Interface

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

inherited

Add a decorator for rendering the element

Inherited from: \Zend_Form_Element::addDecorator()\Zend_Form_Element_Xhtml::addDecorator()

Parameters

Name	Type	Description
$decorator	string \| \Zend_Form_Decorator_Interface
$options	array \| \Zend_Config	Options with which to initialize decorator

Returns

Type	Description
\Zend_Form_Element

addDecorators(array $decorators) : \Zend_Form_Element

inherited

Add many decorators at once

Inherited from: \Zend_Form_Element::addDecorators()\Zend_Form_Element_Xhtml::addDecorators()

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form_Element

addError(string $message) : \Zend_Form_Element

inherited

Add an error message and mark element as failed validation

Inherited from: \Zend_Form_Element::addError()\Zend_Form_Element_Xhtml::addError()

Parameters

Name	Type	Description
$message	string

Returns

Type	Description
\Zend_Form_Element

addErrorMessage(string $message) : \Zend_Form_Element

inherited

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

Inherited from: \Zend_Form_Element::addErrorMessage()\Zend_Form_Element_Xhtml::addErrorMessage()

Parameters

Name	Type	Description
$message	string

Returns

Type	Description
\Zend_Form_Element

addErrorMessages(array $messages) : \Zend_Form_Element

inherited

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

Inherited from: \Zend_Form_Element::addErrorMessages()\Zend_Form_Element_Xhtml::addErrorMessages()

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Form_Element

addErrors(array $messages) : \Zend_Form_Element

inherited

Add multiple error messages and flag element as failed validation

Inherited from: \Zend_Form_Element::addErrors()\Zend_Form_Element_Xhtml::addErrors()

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Form_Element

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

inherited

Add a filter to the element

Inherited from: \Zend_Form_Element::addFilter()\Zend_Form_Element_Xhtml::addFilter()

Parameters

Name	Type	Description
$filter	string \| \Zend_Filter_Interface
$options

Returns

Type	Description
\Zend_Form_Element

addFilters(array $filters) : \Zend_Form_Element

inherited

Add filters to element

Inherited from: \Zend_Form_Element::addFilters()\Zend_Form_Element_Xhtml::addFilters()

Parameters

Name	Type	Description
$filters	array

Returns

Type	Description
\Zend_Form_Element

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

inherited

Add prefix path for plugin loader

Inherited from: \Zend_Form_Element::addPrefixPath()\Zend_Form_Element_Xhtml::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.

Parameters

Name	Type	Description
$prefix	string
$path	string
$type	string

Returns

Type	Description
\Zend_Form_Element

Throws

Exception	Description
\Zend_Form_Exception	for invalid type

addPrefixPaths(array $spec) : \Zend_Form_Element

inherited

Add many prefix paths at once

Inherited from: \Zend_Form_Element::addPrefixPaths()\Zend_Form_Element_Xhtml::addPrefixPaths()

Parameters

Name	Type	Description
$spec	array

Returns

Type	Description
\Zend_Form_Element

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

inherited

Add validator to validation chain

Inherited from: \Zend_Form_Element::addValidator()\Zend_Form_Element_Xhtml::addValidator()

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

Parameters

Name	Type	Description
$validator	string \| \Zend_Validate_Interface
$breakChainOnFailure	bool
$options	array

Returns

Type	Description
\Zend_Form_Element

Throws

Exception	Description
\Zend_Form_Exception	if invalid validator type

addValidators(array $validators) : \Zend_Form_Element

inherited

Add multiple validators

Inherited from: \Zend_Form_Element::addValidators()\Zend_Form_Element_Xhtml::addValidators()

Parameters

Name	Type	Description
$validators	array

Returns

Type	Description
\Zend_Form_Element

autoInsertNotEmptyValidator() : bool

inherited

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

Inherited from: \Zend_Form_Element::autoInsertNotEmptyValidator()\Zend_Form_Element_Xhtml::autoInsertNotEmptyValidator()

Returns

Type	Description
bool

clearDecorators() : \Zend_Form_Element

inherited

Clear all decorators

Inherited from: \Zend_Form_Element::clearDecorators()\Zend_Form_Element_Xhtml::clearDecorators()

Returns

Type	Description
\Zend_Form_Element

clearErrorMessages() : \Zend_Form_Element

inherited

Clear custom error messages stack

Inherited from: \Zend_Form_Element::clearErrorMessages()\Zend_Form_Element_Xhtml::clearErrorMessages()

Returns

Type	Description
\Zend_Form_Element

clearFilters() : \Zend_Form_Element

inherited

Clear all filters

Inherited from: \Zend_Form_Element::clearFilters()\Zend_Form_Element_Xhtml::clearFilters()

Returns

Type	Description
\Zend_Form_Element

clearValidators() : \Zend_Form_Element

inherited

Clear all validators

Inherited from: \Zend_Form_Element::clearValidators()\Zend_Form_Element_Xhtml::clearValidators()

Returns

Type	Description
\Zend_Form_Element

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

inherited

Filter a name to only allow valid variable characters

Inherited from: \Zend_Form_Element::filterName()\Zend_Form_Element_Xhtml::filterName()

Parameters

Name	Type	Description
$value	string
$allowBrackets	bool

Returns

Type	Description
string

getAllowEmpty() : bool

inherited

Get 'allow empty' flag

Inherited from: \Zend_Form_Element::getAllowEmpty()\Zend_Form_Element_Xhtml::getAllowEmpty()

Returns

Type	Description
bool

getAttrib(string $name) : string

inherited

Retrieve element attribute

Inherited from: \Zend_Form_Element::getAttrib()\Zend_Form_Element_Xhtml::getAttrib()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

getAttribs() : array

inherited

Return all attributes

Inherited from: \Zend_Form_Element::getAttribs()\Zend_Form_Element_Xhtml::getAttribs()

Returns

Type	Description
array

getBelongsTo() : string

inherited

Return array name to which element belongs

Inherited from: \Zend_Form_Element::getBelongsTo()\Zend_Form_Element_Xhtml::getBelongsTo()

Returns

Type	Description
string

getDecorator(string $name) : false | \Zend_Form_Decorator_Abstract

inherited

Retrieve a registered decorator

Inherited from: \Zend_Form_Element::getDecorator()\Zend_Form_Element_Xhtml::getDecorator()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
false \| \Zend_Form_Decorator_Abstract

getDecorators() : array

inherited

Retrieve all decorators

Inherited from: \Zend_Form_Element::getDecorators()\Zend_Form_Element_Xhtml::getDecorators()

Returns

Type	Description
array

getDescription() : string

inherited

Retrieve element description

Inherited from: \Zend_Form_Element::getDescription()\Zend_Form_Element_Xhtml::getDescription()

Returns

Type	Description
string

getErrorMessageSeparator() : string

inherited

Get errorMessageSeparator

Inherited from: \Zend_Form_Element::getErrorMessageSeparator()\Zend_Form_Element_Xhtml::getErrorMessageSeparator()

Returns

Type	Description
string

getErrorMessages() : array

inherited

Retrieve custom error messages

Inherited from: \Zend_Form_Element::getErrorMessages()\Zend_Form_Element_Xhtml::getErrorMessages()

Returns

Type	Description
array

getErrors() : array

inherited

Retrieve validator chain errors

Inherited from: \Zend_Form_Element::getErrors()\Zend_Form_Element_Xhtml::getErrors()

Returns

Type	Description
array

getFilter(string $name) : \Zend_Filter_Interface

inherited

Retrieve a single filter by name

Inherited from: \Zend_Form_Element::getFilter()\Zend_Form_Element_Xhtml::getFilter()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Filter_Interface

getFilters() : array

inherited

Get all filters

Inherited from: \Zend_Form_Element::getFilters()\Zend_Form_Element_Xhtml::getFilters()

Returns

Type	Description
array

getFullyQualifiedName() : string

inherited

Get fully qualified name

Inherited from: \Zend_Form_Element::getFullyQualifiedName()\Zend_Form_Element_Xhtml::getFullyQualifiedName()

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

Returns

Type	Description
string

getHash() : string

Retrieve CSRF token

If no CSRF token currently exists, generates one.

Returns

Type	Description
string

getId() : string

inherited

Get element id

Inherited from: \Zend_Form_Element::getId()\Zend_Form_Element_Xhtml::getId()

Returns

Type	Description
string

getIgnore() : bool

inherited

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

Inherited from: \Zend_Form_Element::getIgnore()\Zend_Form_Element_Xhtml::getIgnore()

Returns

Type	Description
bool

getLabel() : null

Override getLabel() to always be empty

Returns

Type	Description
null

getMessages() : array

inherited

Retrieve error messages

Inherited from: \Zend_Form_Element::getMessages()\Zend_Form_Element_Xhtml::getMessages()

The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

Returns

Type	Description
array

getName() : string

inherited

Return element name

Inherited from: \Zend_Form_Element::getName()\Zend_Form_Element_Xhtml::getName()

Returns

Type	Description
string

getOrder() : int

inherited

Retrieve element order

Inherited from: \Zend_Form_Element::getOrder()\Zend_Form_Element_Xhtml::getOrder()

Returns

Type	Description
int

getPluginLoader(string $type) : \Zend_Loader_PluginLoader

inherited

Retrieve plugin loader for validator or filter chain

Inherited from: \Zend_Form_Element::getPluginLoader()\Zend_Form_Element_Xhtml::getPluginLoader()

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

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Loader_PluginLoader

Throws

Exception	Description
\Zend_Loader_Exception	on invalid type.

getSalt() : string

Retrieve salt for CSRF token

Returns

Type	Description
string

getSession() : \Zend_Session_Namespace

Get session object

Instantiate session object if none currently exists

Returns

Type	Description
\Zend_Session_Namespace

getSessionName() : string

Get session namespace for CSRF token

Generates a session namespace based on salt, element name, and class.

Returns

Type	Description
string

getTimeout() : int

Get CSRF session token timeout

Returns

Type	Description
int

getTranslator() : \Zend_Translate_Adapter | null

inherited

Retrieve localization translator object

Inherited from: \Zend_Form_Element::getTranslator()\Zend_Form_Element_Xhtml::getTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

getType() : string

inherited

Return element type

Inherited from: \Zend_Form_Element::getType()\Zend_Form_Element_Xhtml::getType()

Returns

Type	Description
string

getUnfilteredValue() : mixed

inherited

Retrieve unfiltered element value

Inherited from: \Zend_Form_Element::getUnfilteredValue()\Zend_Form_Element_Xhtml::getUnfilteredValue()

Returns

Type	Description
mixed

getValidator(string $name) : \Zend_Validate_Interface | false

inherited

Retrieve a single validator by name

Inherited from: \Zend_Form_Element::getValidator()\Zend_Form_Element_Xhtml::getValidator()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Validate_Interface \| false	False if not found, validator otherwise

getValidators() : array

inherited

Retrieve all validators

Inherited from: \Zend_Form_Element::getValidators()\Zend_Form_Element_Xhtml::getValidators()

Returns

Type	Description
array

getValue() : mixed

inherited

Retrieve filtered element value

Inherited from: \Zend_Form_Element::getValue()\Zend_Form_Element_Xhtml::getValue()

Returns

Type	Description
mixed

getView() : null | \Zend_View_Interface

inherited

Retrieve view object

Inherited from: \Zend_Form_Element::getView()\Zend_Form_Element_Xhtml::getView()

Retrieves from ViewRenderer if none previously set.

Returns

Type	Description
null \| \Zend_View_Interface

hasErrors() : bool

inherited

Are there errors registered?

Inherited from: \Zend_Form_Element::hasErrors()\Zend_Form_Element_Xhtml::hasErrors()

Returns

Type	Description
bool

hasTranslator() : bool

inherited

Does this element have its own specific translator?

Inherited from: \Zend_Form_Element::hasTranslator()\Zend_Form_Element_Xhtml::hasTranslator()

Returns

Type	Description
bool

init() : void

inherited

Initialize object; used by extending classes

Inherited from: \Zend_Form_Element::init()\Zend_Form_Element_Xhtml::init()

initCsrfToken() : void

Initialize CSRF token in session

initCsrfValidator() : \Zend_Form_Element_Hash

Initialize CSRF validator

Creates Session namespace, and initializes CSRF token in session. Additionally, adds validator for validating CSRF token.

Returns

Type	Description
\Zend_Form_Element_Hash

isArray() : bool

inherited

Is the element representing an array?

Inherited from: \Zend_Form_Element::isArray()\Zend_Form_Element_Xhtml::isArray()

Returns

Type	Description
bool

isRequired() : bool

inherited

Is the element required?

Inherited from: \Zend_Form_Element::isRequired()\Zend_Form_Element_Xhtml::isRequired()

Returns

Type	Description
bool

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

inherited

Validate element value

Inherited from: \Zend_Form_Element::isValid()\Zend_Form_Element_Xhtml::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.

Parameters

Name	Type	Description
$value	mixed
$context	mixed

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Validate_Exception	If validation of $value is impossible

loadDefaultDecorators() : \Zend_Form_Element

inherited

Load default decorators

Inherited from: \Zend_Form_Element::loadDefaultDecorators()\Zend_Form_Element_Xhtml::loadDefaultDecorators()

Returns

Type	Description
\Zend_Form_Element

loadDefaultDecoratorsIsDisabled() : bool

inherited

Should we load the default decorators?

Inherited from: \Zend_Form_Element::loadDefaultDecoratorsIsDisabled()\Zend_Form_Element_Xhtml::loadDefaultDecoratorsIsDisabled()

Returns

Type	Description
bool

markAsError() : \Zend_Form_Element

inherited

Mark the element as being in a failed validation state

Inherited from: \Zend_Form_Element::markAsError()\Zend_Form_Element_Xhtml::markAsError()

Returns

Type	Description
\Zend_Form_Element

removeDecorator(string $name) : \Zend_Form_Element

inherited

Remove a single decorator

Inherited from: \Zend_Form_Element::removeDecorator()\Zend_Form_Element_Xhtml::removeDecorator()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_Element

removeFilter(string $name) : \Zend_Form_Element

inherited

Remove a filter by name

Inherited from: \Zend_Form_Element::removeFilter()\Zend_Form_Element_Xhtml::removeFilter()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_Element

removeValidator(string $name) : bool

inherited

Remove a single validator by name

Inherited from: \Zend_Form_Element::removeValidator()\Zend_Form_Element_Xhtml::removeValidator()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

render(\Zend_View_Interface $view = null) : string

Render CSRF token in form

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
string

resolveElementId(\Zend_Form_Decorator_Interface $decorator) : string

staticinherited

Used to resolve and return an element ID

Inherited from: \Zend_Form_Element::resolveElementId()\Zend_Form_Element_Xhtml::resolveElementId()

Passed to the HtmlTag decorator as a callback in order to provide an ID.

Parameters

Name	Type	Description
$decorator	\Zend_Form_Decorator_Interface

Returns

Type	Description
string

setAllowEmpty(bool $flag) : \Zend_Form_Element

inherited

Set 'allow empty' flag

Inherited from: \Zend_Form_Element::setAllowEmpty()\Zend_Form_Element_Xhtml::setAllowEmpty()

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

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Element

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

inherited

Set element attribute

Inherited from: \Zend_Form_Element::setAttrib()\Zend_Form_Element_Xhtml::setAttrib()

Parameters

Name	Type	Description
$name	string
$value	mixed

Returns

Type	Description
\Zend_Form_Element

Throws

Exception	Description
\Zend_Form_Exception	for invalid $name values

setAttribs(array $attribs) : \Zend_Form_Element

inherited

Set multiple attributes at once

Inherited from: \Zend_Form_Element::setAttribs()\Zend_Form_Element_Xhtml::setAttribs()

Parameters

Name	Type	Description
$attribs	array

Returns

Type	Description
\Zend_Form_Element

setAutoInsertNotEmptyValidator(bool $flag) : \Zend_Form_Element

inherited

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

Inherited from: \Zend_Form_Element::setAutoInsertNotEmptyValidator()\Zend_Form_Element_Xhtml::setAutoInsertNotEmptyValidator()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Element

setBelongsTo(string $array) : \Zend_Form_Element

inherited

Set array to which element belongs

Inherited from: \Zend_Form_Element::setBelongsTo()\Zend_Form_Element_Xhtml::setBelongsTo()

Parameters

Name	Type	Description
$array	string

Returns

Type	Description
\Zend_Form_Element

setConfig(\Zend_Config $config) : \Zend_Form_Element

inherited

Set object state from Zend_Config object

Inherited from: \Zend_Form_Element::setConfig()\Zend_Form_Element_Xhtml::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Form_Element

setDecorators(array $decorators) : \Zend_Form_Element

inherited

Overwrite all decorators

Inherited from: \Zend_Form_Element::setDecorators()\Zend_Form_Element_Xhtml::setDecorators()

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form_Element

setDescription(string $description) : \Zend_Form_Element

inherited

Set element description

Inherited from: \Zend_Form_Element::setDescription()\Zend_Form_Element_Xhtml::setDescription()

Parameters

Name	Type	Description
$description	string

Returns

Type	Description
\Zend_Form_Element

setDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_Element

inherited

Set flag to disable loading default decorators

Inherited from: \Zend_Form_Element::setDisableLoadDefaultDecorators()\Zend_Form_Element_Xhtml::setDisableLoadDefaultDecorators()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Element

setDisableTranslator(bool $flag) : \Zend_Form_Element

inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Form_Element::setDisableTranslator()\Zend_Form_Element_Xhtml::setDisableTranslator()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Element

setErrorMessageSeparator(string $separator) : \Zend_Form_Element

inherited

Set errorMessageSeparator

Inherited from: \Zend_Form_Element::setErrorMessageSeparator()\Zend_Form_Element_Xhtml::setErrorMessageSeparator()

Parameters

Name	Type	Description
$separator	string

Returns

Type	Description
\Zend_Form_Element

setErrorMessages(array $messages) : \Zend_Form_Element

inherited

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

Inherited from: \Zend_Form_Element::setErrorMessages()\Zend_Form_Element_Xhtml::setErrorMessages()

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Form_Element

setErrors(array $messages) : \Zend_Form_Element

inherited

Overwrite any previously set error messages and flag as failed validation

Inherited from: \Zend_Form_Element::setErrors()\Zend_Form_Element_Xhtml::setErrors()

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Form_Element

setFilters(array $filters) : \Zend_Form_Element

inherited

Add filters to element, overwriting any already existing

Inherited from: \Zend_Form_Element::setFilters()\Zend_Form_Element_Xhtml::setFilters()

Parameters

Name	Type	Description
$filters	array

Returns

Type	Description
\Zend_Form_Element

setIgnore(bool $flag) : \Zend_Form_Element

inherited

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

Inherited from: \Zend_Form_Element::setIgnore()\Zend_Form_Element_Xhtml::setIgnore()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Element

setIsArray(bool $flag) : \Zend_Form_Element

inherited

Set flag indicating if element represents an array

Inherited from: \Zend_Form_Element::setIsArray()\Zend_Form_Element_Xhtml::setIsArray()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Element

setLabel(string $label) : \Zend_Form_Element

inherited

Set element label

Inherited from: \Zend_Form_Element::setLabel()\Zend_Form_Element_Xhtml::setLabel()

Parameters

Name	Type	Description
$label	string

Returns

Type	Description
\Zend_Form_Element

setName(string $name) : \Zend_Form_Element

inherited

Set element name

Inherited from: \Zend_Form_Element::setName()\Zend_Form_Element_Xhtml::setName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_Element

setOptions(array $options) : \Zend_Form_Element

inherited

Set object state from options array

Inherited from: \Zend_Form_Element::setOptions()\Zend_Form_Element_Xhtml::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_Element

setOrder(int $order) : \Zend_Form_Element

inherited

Set element order

Inherited from: \Zend_Form_Element::setOrder()\Zend_Form_Element_Xhtml::setOrder()

Parameters

Name	Type	Description
$order	int

Returns

Type	Description
\Zend_Form_Element

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

inherited

Set plugin loader to use for validator or filter chain

Inherited from: \Zend_Form_Element::setPluginLoader()\Zend_Form_Element_Xhtml::setPluginLoader()

Parameters

Name	Type	Description
$loader	\Zend_Loader_PluginLoader_Interface
$type	string	'decorator', 'filter', or 'validate'

Returns

Type	Description
\Zend_Form_Element

Throws

Exception	Description
\Zend_Form_Exception	on invalid type

setRequired(bool $flag = true) : \Zend_Form_Element

inherited

Set required flag

Inherited from: \Zend_Form_Element::setRequired()\Zend_Form_Element_Xhtml::setRequired()

Parameters

Name	Type	Description
$flag	bool	Default value is true

Returns

Type	Description
\Zend_Form_Element

setSalt(string $salt) : \Zend_Form_Element_Hash

Salt for CSRF token

Parameters

Name	Type	Description
$salt	string

Returns

Type	Description
\Zend_Form_Element_Hash

setSession(\Zend_Session_Namespace $session) : \Zend_Form_Element_Hash

Set session object

Parameters

Name	Type	Description
$session	\Zend_Session_Namespace

Returns

Type	Description
\Zend_Form_Element_Hash

setTimeout(int $ttl) : \Zend_Form_Element_Hash

Set timeout for CSRF session token

Parameters

Name	Type	Description
$ttl	int

Returns

Type	Description
\Zend_Form_Element_Hash

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

inherited

Set translator object for localization

Inherited from: \Zend_Form_Element::setTranslator()\Zend_Form_Element_Xhtml::setTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| null

Returns

Type	Description
\Zend_Form_Element

setValidators(array $validators) : \Zend_Form_Element

inherited

Set multiple validators, overwriting previous validators

Inherited from: \Zend_Form_Element::setValidators()\Zend_Form_Element_Xhtml::setValidators()

Parameters

Name	Type	Description
$validators	array

Returns

Type	Description
\Zend_Form_Element

setValue(mixed $value) : \Zend_Form_Element

inherited

Set element value

Inherited from: \Zend_Form_Element::setValue()\Zend_Form_Element_Xhtml::setValue()

Parameters

Name	Type	Description
$value	mixed

Returns

Type	Description
\Zend_Form_Element

setView(\Zend_View_Interface $view = null) : \Zend_Form_Element

inherited

Set view object

Inherited from: \Zend_Form_Element::setView()\Zend_Form_Element_Xhtml::setView()

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_Form_Element

translatorIsDisabled() : bool

inherited

Is translation disabled?

Inherited from: \Zend_Form_Element::translatorIsDisabled()\Zend_Form_Element_Xhtml::translatorIsDisabled()

Returns

Type	Description
bool

Form/Element/Hash.php

\Zend_Form_Element_Hashjump to top

Constants

Properties

Methods

\Zend_Form_Element_Hash
jump to top