1991. Class

1991.1. Zend\Validator\Csrf

1991.1.1. Methods

1991.1.1.1. __construct

__construct()

Constructor

Parameters:array|Traversable –

1991.1.1.2. isValid

isValid()

Does the provided token match the one generated?

Parameters:

• string –
• mixed –

Return type:

bool

1991.1.1.3. setName

setName()

Set CSRF name

Parameters:string – Return type:Csrf

1991.1.1.4. getName

getName()

Get CSRF name

Return type:string

1991.1.1.5. setSession

setSession()

Set session container

Parameters:SessionContainer – Return type:Csrf

1991.1.1.6. getSession

getSession()

Get session container

Instantiate session container if none currently exists

Return type:SessionContainer

1991.1.1.7. setSalt

setSalt()

Salt for CSRF token

Parameters:string – Return type:Csrf

1991.1.1.8. getSalt

getSalt()

Retrieve salt for CSRF token

Return type:string

1991.1.1.9. getHash

getHash()

Retrieve CSRF token

If no CSRF token currently exists, or should be regenerated, generates one.

Parameters:bool – default false Return type:string

1991.1.1.10. getSessionName

getSessionName()

Get session namespace for CSRF token

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

Return type:string

1991.1.1.11. setTimeout

setTimeout()

Set timeout for CSRF session token

Parameters:int|null – Return type:Csrf

1991.1.1.12. getTimeout

getTimeout()

Get CSRF session token timeout

Return type:int

1991.1.1.13. initCsrfToken

initCsrfToken()

Initialize CSRF token in session

Return type:void

1991.1.1.14. generateHash

generateHash()

Generate CSRF token

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

Return type:void

1991.1.1.15. getValidationToken

getValidationToken()

Get validation token

Retrieve token from session, if it exists.

Return type:null|string

1991.1.2. Constants

1991.1.2.1. NOT_SAME

Error codes