Form/Element/Hash.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
subpackage: Element
Classes: Zend_Form_Element_Hash

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

Extends from: Zend_Form_Element_Xhtml
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: Hash.php 20096 2010-01-06 02:05:09Z bkarwin $
Properties: $helper; $_hash; $_salt; $_session; $_timeout
Methods: __construct; setSession; getSession; initCsrfValidator; setSalt; getSalt; getHash; getSessionName; setTimeout; getTimeout; getLabel; initCsrfToken; render; _generateHash

Description

CSRF form protection

Properties

$_hash
jump to class

mixed $_hash = ''

Actual hash used.

Details

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

$_salt
jump to class

string $_salt = 'salt'

Salt for CSRF token

Details

$_salt: string
visibility: protected
default: salt
final: false
static: false

$_session
jump to class

Zend_Session_Namespace $_session = ''

Details

$_session: Zend_Session_Namespace
visibility: protected
default
final: false
static: false

$_timeout
jump to class

int $_timeout = '300'

TTL for CSRF token

Details

$_timeout: int
visibility: protected
default: 300
final: false
static: false

$helper
jump to class

string $helper = 'formHidden'

Use formHidden view helper by default

Details

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

Methods

__construct
jump to class

__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.

Arguments

$spec: stringarrayZend_Config
$options: arrayZend_Config

Details

visibility: public
final: false
static: false

_generateHash
jump to class

_generateHash(
          
          )
        
        :
        void

Generate CSRF token

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

Details

visibility: protected
final: false
static: false

getHash
jump to class

getHash(
          
          )
        
        :
        string

Retrieve CSRF token

If no CSRF token currently exists, generates one.

Output

string

Details

visibility: public
final: false
static: false

getLabel
jump to class

getLabel(
          
          )
        
        :
        null

Override getLabel() to always be empty

Output

null

Details

visibility: public
final: false
static: false

getSalt
jump to class

getSalt(
          
          )
        
        :
        string

Retrieve salt for CSRF token

Output

string

Details

visibility: public
final: false
static: false

getSession
jump to class

getSession(
          
          )
        
        :
        Zend_Session_Namespace

Get session object

Instantiate session object if none currently exists

Output

Zend_Session_Namespace

Details

visibility: public
final: false
static: false

getSessionName
jump to class

getSessionName(
          
          )
        
        :
        string

Get session namespace for CSRF token

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

Output

string

Details

visibility: public
final: false
static: false

getTimeout
jump to class

getTimeout(
          
          )
        
        :
        int

Get CSRF session token timeout

Output

int

Details

visibility: public
final: false
static: false

initCsrfToken
jump to class

initCsrfToken(
          
          )
        
        :
        void

Initialize CSRF token in session

Details

visibility: public
final: false
static: false

initCsrfValidator
jump to class

initCsrfValidator(
          
          )
        
        :
        Zend_Form_Element_Hash

Initialize CSRF validator

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

Output

Zend_Form_Element_Hash

Details

visibility: public
final: false
static: false

render
jump to class

render(
          Zend_View_Interface $view
              =
              null
          )
        
        :
        string

Render CSRF token in form

Arguments

$view: Zend_View_Interface

Output

string

Details

visibility: public
final: false
static: false

setSalt
jump to class

setSalt(
          string $salt
          )
        
        :
        Zend_Form_Element_Hash

Salt for CSRF token

Arguments

$salt: string

Output

Zend_Form_Element_Hash

Details

visibility: public
final: false
static: false

setSession
jump to class

setSession(
          Zend_Session_Namespace $session
          )
        
        :
        Zend_Form_Element_Hash

Set session object

Arguments

$session: Zend_Session_Namespace

Output

Zend_Form_Element_Hash

Details

visibility: public
final: false
static: false

setTimeout
jump to class

setTimeout(
          int $ttl
          )
        
        :
        Zend_Form_Element_Hash

Set timeout for CSRF session token

Arguments

$ttl: int

Output

Zend_Form_Element_Hash

Details

visibility: public
final: false
static: false

API Documentation

Form/Element/Hash.php

Description

Zend_Form_Element_Hashjump to top

Description

Properties

$_hashjump to class

Details

$_saltjump to class

Details

$_sessionjump to class

Details

$_timeoutjump to class

Details

$helperjump to class

Details

Methods

__constructjump to class

Arguments

Details

_generateHashjump to class

Details

getHashjump to class

Output

Details

getLabeljump to class

Output

Details

getSaltjump to class

Output

Details

getSessionjump to class

Output

Details

getSessionNamejump to class

Output

Details

getTimeoutjump to class

Output

Details

initCsrfTokenjump to class

Details

initCsrfValidatorjump to class

Output

Details

renderjump to class

Arguments

Output

Details

setSaltjump to class

Arguments

Output

Details

setSessionjump to class

Arguments

Output

Details

setTimeoutjump to class

Arguments

Output

Details

Zend_Form_Element_Hash
jump to top

$_hash
jump to class

$_salt
jump to class

$_session
jump to class

$_timeout
jump to class

$helper
jump to class

__construct
jump to class

_generateHash
jump to class

getHash
jump to class

getLabel
jump to class

getSalt
jump to class

getSession
jump to class

getSessionName
jump to class

getTimeout
jump to class

initCsrfToken
jump to class

initCsrfValidator
jump to class

render
jump to class

setSalt
jump to class

setSession
jump to class

setTimeout
jump to class