Authentication Class Reference

Authentication Validator. More...

Public Member Functions
	__construct ($options=null)
	Sets validator options.
	getAdapter ()
	Get Adapter.
	setAdapter (ValidatableAdapterInterface $adapter)
	Set Adapter.
	getIdentity ()
	Get Identity.
	setIdentity ($identity)
	Set Identity.
	getCredential ()
	Get Credential.
	setCredential ($credential)
	Set Credential.
	getService ()
	Get Service.
	setService (AuthenticationService $service)
	Set Service.
	isValid ($value=null, $context=null)
	Is Valid.
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 Attributes
const	IDENTITY_NOT_FOUND = 'identityNotFound'
	Error codes string.
const	IDENTITY_AMBIGUOUS = 'identityAmbiguous'
const	CREDENTIAL_INVALID = 'credentialInvalid'
const	UNCATEGORIZED = 'uncategorized'
const	GENERAL = 'general'

Protected Attributes
	$messageTemplates
	$adapter
	$identity
	$credential
	$service
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

Authentication Validator.

Constructor & Destructor Documentation

__construct

(

$options = null

)

Sets validator options.

Parameters

mixed

$options

Member Function Documentation

getAdapter

(

)

Get Adapter.

Returns

ValidatableAdapterInterface

getCredential

(

)

Get Credential.

Returns

mixed

getIdentity

(

)

Get Identity.

Returns

mixed

getService

(

)

Get Service.

Returns

AuthenticationService

isValid	(		$value = null,
			$context = null
	)

Is Valid.

Parameters

mixed	$value
array	$context

Returns

bool

setAdapter

(

ValidatableAdapterInterface

$adapter

)

Set Adapter.

Parameters

ValidatableAdapterInterface

$adapter

Returns

Authentication

setCredential

(

$credential

)

Set Credential.

Parameters

mixed

$credential

Returns

Authentication

setIdentity

(

$identity

)

Set Identity.

Parameters

mixed

$identity

Returns

Authentication

setService

(

AuthenticationService

$service

)

Set Service.

Parameters

AuthenticationService

$service

Returns

Authentication

Member Data Documentation

$adapter

protected

$credential

protected

$identity

protected

$messageTemplates

protected

Initial value:

= [
        self::IDENTITY_NOT_FOUND => 'Invalid identity'

$service

protected

const CREDENTIAL_INVALID = 'credentialInvalid'

const GENERAL = 'general'

const IDENTITY_AMBIGUOUS = 'identityAmbiguous'

const IDENTITY_NOT_FOUND = 'identityNotFound'

Error codes string.

const UNCATEGORIZED = 'uncategorized'