PHP Класс Zend_Form_Element_Hash

Наследование: extends Zend_Form_Element_Xhtml
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$helper string Use formHidden view helper by default

Защищенные свойства (Protected)

Свойство Тип Описание
$_hash mixed Actual hash used.
$_salt string Salt for CSRF token
$_session Zend_Session_Namespace
$_timeout integer TTL for CSRF token

Открытые методы

Метод Описание
__construct ( string | array | Zend_Config $spec, array | Zend_Config $options = null ) : void Constructor
getHash ( ) : string Retrieve CSRF token
getLabel ( ) : null Override getLabel() to always be empty
getSalt ( ) : string Retrieve salt for CSRF token
getSession ( ) : Zend_Session_Namespace Get session object
getSessionName ( ) : string Get session namespace for CSRF token
getTimeout ( ) : integer Get CSRF session token timeout
initCsrfToken ( ) : void Initialize CSRF token in session
initCsrfValidator ( ) : Zend_Form_Element_Hash Initialize CSRF validator
render ( Zend_View_Interface $view = null ) : string Render CSRF token in form
setSalt ( string $salt ) : Zend_Form_Element_Hash Salt for CSRF token
setSession ( Zend_Session_Namespace $session ) : Zend_Form_Element_Hash Set session object
setTimeout ( integer $ttl ) : Zend_Form_Element_Hash Set timeout for CSRF session token

Защищенные методы

Метод Описание
_generateHash ( ) : void Generate CSRF token

Описание методов

__construct() публичный Метод

Creates session namespace for CSRF token, and adds validator for CSRF token.
public __construct ( string | array | Zend_Config $spec, array | Zend_Config $options = null ) : void
$spec string | array | Zend_Config
$options array | Zend_Config
Результат void

_generateHash() защищенный Метод

Generates CSRF token and stores both in {@link $_hash} and element value.
protected _generateHash ( ) : void
Результат void

getHash() публичный Метод

If no CSRF token currently exists, generates one.
public getHash ( ) : string
Результат string

getLabel() публичный Метод

Override getLabel() to always be empty
public getLabel ( ) : null
Результат null

getSalt() публичный Метод

Retrieve salt for CSRF token
public getSalt ( ) : string
Результат string

getSession() публичный Метод

Instantiate session object if none currently exists
public getSession ( ) : Zend_Session_Namespace
Результат Zend_Session_Namespace

getSessionName() публичный Метод

Generates a session namespace based on salt, element name, and class.
public getSessionName ( ) : string
Результат string

getTimeout() публичный Метод

Get CSRF session token timeout
public getTimeout ( ) : integer
Результат integer

initCsrfToken() публичный Метод

Initialize CSRF token in session
public initCsrfToken ( ) : void
Результат void

initCsrfValidator() публичный Метод

Creates Session namespace, and initializes CSRF token in session. Additionally, adds validator for validating CSRF token.
public initCsrfValidator ( ) : Zend_Form_Element_Hash
Результат Zend_Form_Element_Hash

render() публичный Метод

Render CSRF token in form
public render ( Zend_View_Interface $view = null ) : string
$view Zend_View_Interface
Результат string

setSalt() публичный Метод

Salt for CSRF token
public setSalt ( string $salt ) : Zend_Form_Element_Hash
$salt string
Результат Zend_Form_Element_Hash

setSession() публичный Метод

Set session object
public setSession ( Zend_Session_Namespace $session ) : Zend_Form_Element_Hash
$session Zend_Session_Namespace
Результат Zend_Form_Element_Hash

setTimeout() публичный Метод

Set timeout for CSRF session token
public setTimeout ( integer $ttl ) : Zend_Form_Element_Hash
$ttl integer
Результат Zend_Form_Element_Hash

Описание свойств

$_hash защищенное свойство

Actual hash used.
protected mixed $_hash
Результат mixed

$_salt защищенное свойство

Salt for CSRF token
protected string $_salt
Результат string

$_session защищенное свойство

protected Zend_Session_Namespace $_session
Результат Zend_Session_Namespace

$_timeout защищенное свойство

TTL for CSRF token
protected int $_timeout
Результат integer

$helper публичное свойство

Use formHidden view helper by default
public string $helper
Результат string