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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id$

Properties

mixed $_hash

Actual hash used.

Details

Type: mixed

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

string $helper = 'formHidden'

Use formHidden view helper by default

Default value'formHidden'Details

Type: string

Methods

__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

_generateHash() : void

Generate CSRF token

Generates CSRF token and stores both in {@link $_hash} and element value.

getHash() : string

Retrieve CSRF token

If no CSRF token currently exists, generates one.

Returns

Type	Description
string

getLabel() : null

Override getLabel() to always be empty

Returns

Type	Description
null

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

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

render(\Zend_View_Interface $view = null) : string

Render CSRF token in form

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
string

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

Form/Element/Hash.php

\Zend_Form_Element_Hashjump to top

Properties

Methods

\Zend_Form_Element_Hash
jump to top