Summary

Fully Qualified Name:	Laminas\Validator\Csrf
Extends:	AbstractValidator

Description

Methods

Name	Description	Defined By
__construct()	Constructor	Csrf
__get()	Magic function returns the value of the requested property, if and only if it is the value or a message variable.	AbstractValidator
__invoke()	Invoke as command	AbstractValidator
getDefaultTranslator()	Get default translation object for all validate objects	AbstractValidator
getDefaultTranslatorTextDomain()	Get default translation text domain for all validate objects	AbstractValidator
getHash()	Retrieve CSRF token	Csrf
getMessageLength()	Returns the maximum allowed message length	AbstractValidator
getMessageTemplates()	Returns the message templates from the validator	AbstractValidator
getMessageVariables()	Returns an array of the names of variables that are used in constructing validation failure messages	AbstractValidator
getMessages()	Returns array of validation failure messages	AbstractValidator
getName()	Get CSRF name	Csrf
getOption()	Returns an option	AbstractValidator
getOptions()	Returns all available options	AbstractValidator
getSalt()	Retrieve salt for CSRF token	Csrf
getSession()	Get session container	Csrf
getSessionName()	Get session namespace for CSRF token	Csrf
getTimeout()	Get CSRF session token timeout	Csrf
getTranslator()	Return translation object	AbstractValidator
getTranslatorTextDomain()	Return the translation text domain	AbstractValidator
hasDefaultTranslator()	Is there a default translation object set?	AbstractValidator
hasTranslator()	Does this validator have its own specific translator?	AbstractValidator
isTranslatorEnabled()	Is translation enabled?	AbstractValidator
isValid()	Does the provided token match the one generated?	Csrf
isValueObscured()	Retrieve flag indicating whether or not value should be obfuscated in messages	AbstractValidator
setDefaultTranslator()	Set default translation object for all validate objects	AbstractValidator
setDefaultTranslatorTextDomain()	Set default translation text domain for all validate objects	AbstractValidator
setMessage()	Sets the validation failure message template for a particular key	AbstractValidator
setMessageLength()	Sets the maximum allowed message length	AbstractValidator
setMessages()	Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.	AbstractValidator
setName()	Set CSRF name	Csrf
setOptions()	Sets one or multiple options	AbstractValidator
setSalt()	Salt for CSRF token	Csrf
setSession()	Set session container	Csrf
setTimeout()	Set timeout for CSRF session token	Csrf
setTranslator()	Set translation object	AbstractValidator
setTranslatorEnabled()	Indicate whether or not translation should be enabled	AbstractValidator
setTranslatorTextDomain()	Set translation text domain	AbstractValidator
setValueObscured()	Set flag indicating whether or not value should be obfuscated in messages	AbstractValidator

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	array|\Traversable

Returns:

__get()

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

Parameter Name	Type	Description
$property	string

Returns: mixed

__invoke()

Invoke as command

Parameter Name	Type	Description
$value	mixed

Returns: bool

getDefaultTranslator()

Get default translation object for all validate objects

Returns: \Translator\TranslatorInterface|null

getDefaultTranslatorTextDomain()

Get default translation text domain for all validate objects

Returns: string

getHash()

Retrieve CSRF token

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

Parameter Name	Type	Description
$regenerate	bool	default

Returns: string

getMessageLength()

Returns the maximum allowed message length

Returns: int

getMessageTemplates()

Returns the message templates from the validator

Returns: array

getMessageVariables()

Returns an array of the names of variables that are used in constructing validation failure messages

Returns: array

getMessages()

Returns array of validation failure messages

Returns: array

getName()

Get CSRF name

Returns: string

getOption()

Returns an option

Parameter Name	Type	Description
$option	string	Option

Returns: mixed Returned option

getOptions()

Returns all available options

Returns: array Array with all available options

getSalt()

Retrieve salt for CSRF token

Returns: string

getSession()

Get session container

Instantiate session container if none currently exists

Returns: \SessionContainer

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

getTranslator()

Return translation object

Returns: \Translator\TranslatorInterface|null

getTranslatorTextDomain()

Return the translation text domain

Returns: string

hasDefaultTranslator()

Is there a default translation object set?

Returns: bool

hasTranslator()

Does this validator have its own specific translator?

Returns: bool

isTranslatorEnabled()

Is translation enabled?

Returns: bool

isValid()

Does the provided token match the one generated?

Parameter Name	Type	Description
$value	string
$context	mixed

Returns: bool

isValueObscured()

Retrieve flag indicating whether or not value should be obfuscated in messages

Returns: bool

setDefaultTranslator()

Set default translation object for all validate objects

Parameter Name	Type	Description
$translator	\Translator\TranslatorInterface|null
$textDomain	string	(optional)

Returns: void

setDefaultTranslatorTextDomain()

Set default translation text domain for all validate objects

Parameter Name	Type	Description
$textDomain	string

Returns: void

setMessage()

Sets the validation failure message template for a particular key

Parameter Name	Type	Description
$messageString	string
$messageKey	string	OPTIONAL

Returns: $this Provides a fluent interface

setMessageLength()

Sets the maximum allowed message length

Parameter Name	Type	Description
$length	int

Returns:

setMessages()

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.

Parameter Name	Type	Description
$messages	array

Returns: $this

setName()

Set CSRF name

Parameter Name	Type	Description
$name	string

Returns: $this

setOptions()

Sets one or multiple options

Parameter Name	Type	Description
$options	array|\Traversable	Options

Returns: $this Provides fluid interface

setSalt()

Salt for CSRF token

Parameter Name	Type	Description
$salt	string

Returns: $this

setSession()

Set session container

Parameter Name	Type	Description
$session	\SessionContainer

Returns: $this

setTimeout()

Set timeout for CSRF session token

Parameter Name	Type	Description
$ttl	int|null

Returns: $this

setTranslator()

Set translation object

Parameter Name	Type	Description
$translator	\Translator\TranslatorInterface|null
$textDomain	string	(optional)

Returns: $this

setTranslatorEnabled()

Indicate whether or not translation should be enabled

Parameter Name	Type	Description
$flag	bool

Returns: $this

setTranslatorTextDomain()

Set translation text domain

Parameter Name	Type	Description
$textDomain	string

Returns: $this

setValueObscured()

Set flag indicating whether or not value should be obfuscated in messages

Parameter Name	Type	Description
$flag	bool

Returns: $this