AbstractAdapter Class Reference

Base class for Captcha adapters. More...

Public Member Functions
	getName ()
	Get name.
	setName ($name)
	Set name.
	setOption ($key, $value)
	Set single option for the object.
	setOptions ($options=[])
	Set object state from options array.
	getOptions ()
	Retrieve options representing object state.
	getHelperName ()
	Get helper name used to render captcha.
Public Member Functions inherited from AbstractValidator
	__construct ($options=null)
	Abstract constructor for all validators A validator should accept following parameters:
	getOption ($option)
	Returns an option.
	getOptions ()
	Returns all available options.
	setOptions ($options=[])
	Sets one or multiple options.
	getMessages ()
	Returns array of validation failure messages.
	__invoke ($value)
	Invoke as command.
	getMessageVariables ()
	Returns an array of the names of variables that are used in constructing validation failure messages.
	getMessageTemplates ()
	Returns the message templates from the validator.
	setMessage ($messageString, $messageKey=null)
	Sets the validation failure message template for a particular key.
	setMessages (array $messages)
	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.
	__get ($property)
	Magic function returns the value of the requested property, if and only if it is the value or a message variable.
	setValueObscured ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	isValueObscured ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setTranslatorTextDomain ($textDomain= 'default')
	Set translation text domain.
	getTranslatorTextDomain ()
	Return the translation text domain.
	setTranslatorEnabled ($flag=true)
	Indicate whether or not translation should be enabled.
	isTranslatorEnabled ()
	Is translation enabled?
Public Member Functions inherited from TranslatorAwareInterface
	setTranslator (TranslatorInterface $translator=null, $textDomain=null)
	Sets translator to use in helper.
Public Member Functions inherited from ValidatorInterface
	isValid ($value)
	Returns true if and only if $value meets the validation requirements.
Public Member Functions inherited from AdapterInterface
	generate ()
	Generate a new captcha.

Protected Attributes
	$name
	$options = []
	$skipOptions
Protected Attributes inherited from AbstractValidator
	$value
	$abstractOptions

Additional Inherited Members
Static Public Member Functions inherited from AbstractValidator
static	setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set default translation object for all validate objects.
static	getDefaultTranslator ()
	Get default translation object for all validate objects.
static	hasDefaultTranslator ()
	Is there a default translation object set?
static	setDefaultTranslatorTextDomain ($textDomain= 'default')
	Set default translation text domain for all validate objects.
static	getDefaultTranslatorTextDomain ()
	Get default translation text domain for all validate objects.
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Protected Member Functions inherited from AbstractValidator
	createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	error ($messageKey, $value=null)
	getValue ()
	Returns the validation value.
	setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
	translateMessage ($messageKey, $message)
	Translate a validation message.
Static Protected Attributes inherited from AbstractValidator
static	$defaultTranslator
static	$defaultTranslatorTextDomain = 'default'
static	$messageLength = -1

Detailed Description

Base class for Captcha adapters.

Provides some utility functionality to build on

Member Function Documentation

getHelperName

(

)

Get helper name used to render captcha.

By default, return empty string, indicating no helper needed.

Returns

string

Implements AdapterInterface.

getName

(

)

Get name.

Returns

string

Implements AdapterInterface.

getOptions

(

)

Retrieve options representing object state.

Returns

array

setName

(

$name

)

Set name.

Parameters

string

$name

Returns

AbstractAdapter

Implements AdapterInterface.

setOption	(		$key,
			$value
	)

Set single option for the object.

Parameters

string	$key
string	$value

Returns

AbstractAdapter

setOptions

(

$options = []

)

Set object state from options array.

Parameters

array | Traversable

$options

Exceptions

Exception\InvalidArgumentException

Returns

AbstractAdapter

Member Data Documentation

$name

protected

$options = []

protected

$skipOptions

protected

Initial value:

= [
        'options',
        'config',
    ]