Zend\Authentication\Validator\Authentication
Authentication Validator
Synopsis
class Authentication
extends AbstractValidator
{
- // constants
- const IDENTITY_NOT_FOUND = 'identityNotFound';
- const IDENTITY_AMBIGUOUS = 'identityAmbiguous';
- const CREDENTIAL_INVALID = 'credentialInvalid';
- const UNCATEGORIZED = 'uncategorized';
- const GENERAL = 'general';
- // members
- protected array $messageTemplates;
- protected ValidatableAdapterInterface $adapter;
- protected string $identity;
- protected string $credential;
- protected AuthenticationService $service;
- // Inherited members from AbstractValidator
- protected mixed $value;
- protected TranslatorInterface $defaultTranslator;
- protected string $defaultTranslatorTextDomain;
- protected integer $messageLength;
- protected array $abstractOptions;
- // methods
- public void __construct()
- public ValidatableAdapterInterface getAdapter()
- public Authentication setAdapter()
- public mixed getIdentity()
- public Authentication setIdentity()
- public mixed getCredential()
- public Authentication setCredential()
- public AuthenticationService getService()
- public Authentication setService()
- public bool isValid()
- // Inherited methods from AbstractValidator
- public void __construct()
- public mixed getOption()
- public array getOptions()
- public AbstractValidator setOptions()
- public array getMessages()
- public bool __invoke()
- public array getMessageVariables()
- public array getMessageTemplates()
- public AbstractValidator setMessage()
- public AbstractValidator setMessages()
- public mixed __get()
- protected string createMessage()
- protected void error()
- protected mixed getValue()
- protected void setValue()
- public AbstractValidator setValueObscured()
- public bool isValueObscured()
- public AbstractValidator setTranslator()
- public TranslatorInterface|null getTranslator()
- public bool hasTranslator()
- public AbstractValidator setTranslatorTextDomain()
- public string getTranslatorTextDomain()
- public static void setDefaultTranslator()
- public static TranslatorInterface|null getDefaultTranslator()
- public static bool hasDefaultTranslator()
- public static void setDefaultTranslatorTextDomain()
- public static string getDefaultTranslatorTextDomain()
- public AbstractValidator setTranslatorEnabled()
- public bool isTranslatorEnabled()
- public static int getMessageLength()
- public static void setMessageLength()
- protected string translateMessage()
Hierarchy
Extends
Constants
Name | Value |
---|---|
IDENTITY_NOT_FOUND | 'identityNotFound' |
IDENTITY_AMBIGUOUS | 'identityAmbiguous' |
CREDENTIAL_INVALID | 'credentialInvalid' |
UNCATEGORIZED | 'uncategorized' |
GENERAL | 'general' |
Members
protected
- $abstractOptions
- $adapter
—
Zend\Authentication\Adapter\ValidatableAdapterInterface
Authentication Adapter - $credential
—
string
Credential (or field) - $defaultTranslator
—
Zend\Validator\Translator\TranslatorInterface
Default translation object for all validate objects - $defaultTranslatorTextDomain
—
string
Default text domain to be used with translator - $identity
—
string
Identity (or field) - $messageLength
—
int
Limits the maximum returned length of an error message - $messageTemplates
—
array
Error Messages - $service
—
Zend\Authentication\AuthenticationService
Authentication Service - $value
—
mixed
The value to be validated
Methods
public
- __construct() — Sets validator options
- getAdapter() — Get Adapter
- getCredential() — Get Credential
- getIdentity() — Get Identity
- getService() — Get Service
- isValid() — Is Valid
- setAdapter() — Set Adapter
- setCredential() — Set Credential
- setIdentity() — Set Identity
- setService() — Set Service
Inherited from Zend\Validator\AbstractValidator
protected
- createMessage() — Constructs and returns a validation failure message with the given message key and value.
- error()
- getValue() — Returns the validation value
- setValue() — Sets the value to be validated and clears the messages and errors arrays
- translateMessage() — Translate a validation message
public
- __get() — Magic function returns the value of the requested property, if and only if it is the value or a message variable.
- __invoke() — Invoke as command
- getDefaultTranslator() — Get default translation object for all validate objects
- getDefaultTranslatorTextDomain() — Get default translation text domain for all validate objects
- getMessageLength() — Returns the maximum allowed message length
- getMessageTemplates() — Returns the message templates from the validator
- getMessageVariables() — Returns an array of the names of variables that are used in constructing validation failure messages
- getMessages() — Returns array of validation failure messages
- getOption() — Returns an option
- getOptions() — Returns all available options
- getTranslator() — Return translation object
- getTranslatorTextDomain() — Return the translation text domain
- hasDefaultTranslator() — Is there a default translation object set?
- hasTranslator() — Does this validator have its own specific translator?
- isTranslatorEnabled() — Is translation enabled?
- isValueObscured() — Retrieve flag indicating whether or not value should be obfuscated in messages
- setDefaultTranslator() — Set default translation object for all validate objects
- setDefaultTranslatorTextDomain() — Set default translation text domain for all validate objects
- setMessage() — Sets the validation failure message template for a particular key
- setMessageLength() — Sets the maximum allowed message length
- 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.
- setOptions() — Sets one or multiple options
- setTranslator() — Set translation object
- setTranslatorEnabled() — Indicate whether or not translation should be enabled
- setTranslatorTextDomain() — Set translation text domain
- setValueObscured() — Set flag indicating whether or not value should be obfuscated in messages