Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Zend_Form_Element_Hash Class Reference

Public Member Functions

 __construct ($spec, $options=null)
 Constructor.
 
 setSession ($session)
 Set session object.
 
 getSession ()
 Get session object.
 
 initCsrfValidator ()
 Initialize CSRF validator.
 
 setSalt ($salt)
 Salt for CSRF token.
 
 getSalt ()
 Retrieve salt for CSRF token.
 
 getHash ()
 Retrieve CSRF token.
 
 getSessionName ()
 Get session namespace for CSRF token.
 
 setTimeout ($ttl)
 Set timeout for CSRF session token.
 
 getTimeout ()
 Get CSRF session token timeout.
 
 getLabel ()
 Override getLabel() to always be empty.
 
 initCsrfToken ()
 Initialize CSRF token in session.
 
 render (Zend_View_Interface $view=null)
 Render CSRF token in form.
 

Public Attributes

 $helper = 'formHidden'
 

Protected Member Functions

 _generateHash ()
 Generate CSRF token.
 

Protected Attributes

 $_hash
 
 $_salt = 'salt'
 
 $_session
 
 $_timeout = 300
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Form_Element
static resolveElementId (Zend_Form_Decorator_Interface $decorator)
 Used to resolve and return an element ID.
 

Constructor & Destructor Documentation

__construct (   $spec,
  $options = null 
)

Constructor.

Creates session namespace for CSRF token, and adds validator for CSRF token.

Parameters
string | array | Zend_Config$spec
array | Zend_Config$options
Returns
void

Member Function Documentation

_generateHash ( )
protected

Generate CSRF token.

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

Returns
void
getHash ( )

Retrieve CSRF token.

If no CSRF token currently exists, generates one.

Returns
string
getLabel ( )

Override getLabel() to always be empty.

Returns
null
getSalt ( )

Retrieve salt for CSRF token.

Returns
string
getSession ( )

Get session object.

Instantiate session object if none currently exists

Returns
Zend_Session_Namespace
getSessionName ( )

Get session namespace for CSRF token.

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

Returns
string
getTimeout ( )

Get CSRF session token timeout.

Returns
int
initCsrfToken ( )

Initialize CSRF token in session.

Returns
void
initCsrfValidator ( )

Initialize CSRF validator.

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

Returns
Zend_Form_Element_Hash
render ( Zend_View_Interface  $view = null)

Render CSRF token in form.

Parameters
Zend_View_Interface$view
Returns
string
setSalt (   $salt)

Salt for CSRF token.

Parameters
string$salt
Returns
Zend_Form_Element_Hash
setSession (   $session)

Set session object.

Parameters
Zend_Session_Namespace$session
Returns
Zend_Form_Element_Hash
setTimeout (   $ttl)

Set timeout for CSRF session token.

Parameters
int$ttl
Returns
Zend_Form_Element_Hash

Member Data Documentation

$_hash
protected
$_salt = 'salt'
protected
$_session
protected
$_timeout = 300
protected
$helper = 'formHidden'