Methods
__construct() - Sets configuration options
__construct(\Zend\Db\Adapter\Adapter $zendDb, string $tableName, string $identityColumn, string $credentialColumn, string $credentialTreatment)
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::__construct() |
Parameters
$tableName
stringOptional
$identityColumn
stringOptional
$credentialColumn
stringOptional
$credentialTreatment
stringOptional
This method is called to attempt an authentication.
authenticate() : \Zend\Authentication\Result
Inherited
Previous to this
call, this adapter would have already been configured with all
necessary information to successfully connect to a database table and
attempt to find a record matching the provided identity.
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::authenticate() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::authenticate() |
Exceptions
Returns
getAmbiguityIdentity() - returns TRUE for usage of multiple identical
identities with different credentials, FALSE if not used.
getAmbiguityIdentity() : bool
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::getAmbiguityIdentity() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::getAmbiguityIdentity() |
Returns
bool
Returns the credential of the account being authenticated, or
NULL if none is set.
getCredential() : mixed
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::getCredential() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::getCredential() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::getCredential() |
Returns
mixed
getDbSelect() - Return the preauthentication Db Select object for userland select query modification
getDbSelect() : \Zend\Db\Sql\Select
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::getDbSelect() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::getDbSelect() |
Returns
Returns the identity of the account being authenticated, or
NULL if none is set.
getIdentity() : mixed
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::getIdentity() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::getIdentity() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::getIdentity() |
Returns
mixed
getResultRowObject() - Returns the result row as a stdClass object
getResultRowObject(string | array $returnColumns, string | array $omitColumns) : \stdClass | bool
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::getResultRowObject() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::getResultRowObject() |
Parameters
$returnColumns
stringarray
$omitColumns
stringarray
Returns
setAmbiguityIdentity() - sets a flag for usage of identical identities
with unique credentials.
setAmbiguityIdentity(int | bool $flag) : \Zend\Authentication\Adapter\DbTable\self
Inherited
It accepts integers (0, 1) or boolean (true,
false) parameters. Default is false.
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::setAmbiguityIdentity() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::setAmbiguityIdentity() |
Parameters
$flag
intbool
Returns
\Zend\Authentication\Adapter\DbTable\selfProvides a fluent interface
Sets the credential for binding
setCredential(mixed $credential) : \Zend\Authentication\Adapter\AbstractAdapter
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::setCredential() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::setCredential() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::setCredential() |
Parameters
$credential
mixed
Returns
setCredentialColumn() - set the column name to be used as the credential column
setCredentialColumn(string $credentialColumn) : \Zend\Authentication\Adapter\DbTable\self
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::setCredentialColumn() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::setCredentialColumn() |
Parameters
$credentialColumn
string
Returns
\Zend\Authentication\Adapter\DbTable\selfProvides a fluent interface
setCredentialTreatment() - allows the developer to pass a parametrized string that is
used to transform or treat the input credential data.
setCredentialTreatment(string $treatment) : \Zend\Authentication\Adapter\DbTable\self
Inherited
In many cases, passwords and other sensitive data are encrypted, hashed, encoded,
obscured, or otherwise treated through some function or algorithm. By specifying a
parametrized treatment string with this method, a developer may apply arbitrary SQL
upon input credential data.
Examples:
'PASSWORD(?)'
'MD5(?)'
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::setCredentialTreatment() |
Parameters
$treatment
string
Returns
\Zend\Authentication\Adapter\DbTable\selfProvides a fluent interface
Sets the identity for binding
setIdentity(mixed $identity) : \Zend\Authentication\Adapter\AbstractAdapter
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::setIdentity() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::setIdentity() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::setIdentity() |
Parameters
$identity
mixed
Returns
setIdentityColumn() - set the column name to be used as the identity column
setIdentityColumn(string $identityColumn) : \Zend\Authentication\Adapter\DbTable\self
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::setIdentityColumn() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::setIdentityColumn() |
Parameters
$identityColumn
string
Returns
\Zend\Authentication\Adapter\DbTable\selfProvides a fluent interface
setTableName() - set the table name to be used in the select query
setTableName(string $tableName) : \Zend\Authentication\Adapter\DbTable\self
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::setTableName() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::setTableName() |
Parameters
$tableName
string
Returns
\Zend\Authentication\Adapter\DbTable\selfProvides a fluent interface
Creates a Zend\Authentication\Result object from the information that
has been collected during the authenticate() attempt.
authenticateCreateAuthResult() : \Zend\Authentication\Result
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::authenticateCreateAuthResult() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::authenticateCreateAuthResult() |
Returns
_authenticateCreateSelect() - This method creates a Zend\Db\Sql\Select object that
is completely configured to be queried against the database.
authenticateCreateSelect() : \Zend\Db\Sql\Select
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::authenticateCreateSelect() |
Returns
_authenticateQuerySelect() - This method accepts a Zend\Db\Sql\Select object and
performs a query against the database with that object.
authenticateQuerySelect(\Zend\Db\Sql\Select $dbSelect) : array
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::authenticateQuerySelect() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::authenticateQuerySelect() |
Parameters
Exceptions
Returns
array
_authenticateSetup() - This method abstracts the steps involved with
making sure that this adapter was indeed setup properly with all
required pieces of information.
authenticateSetup() : bool
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::authenticateSetup() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::authenticateSetup() |
Exceptions
Returns
bool
_authenticateValidateResult() - This method attempts to validate that
the record in the resultset is indeed a record that matched the
identity provided to this adapter.
authenticateValidateResult(array $resultIdentity) : \Zend\Authentication\Result
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::authenticateValidateResult() |
Parameters
$resultIdentity
array
Returns
_authenticateValidateResultSet() - This method attempts to make
certain that only one record was returned in the resultset
authenticateValidateResultSet(array $resultIdentities) : bool | \Zend\Authentication\Result
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::authenticateValidateResultSet() |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::authenticateValidateResultSet() |
Parameters
$resultIdentities
array
Returns
Properties
$ambiguityIdentity - Flag to indicate same Identity can be used with
different credentials.
$ambiguityIdentity : bool
Inherited
Default is FALSE and need to be set to true to
allow ambiguity usage.
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$ambiguityIdentity |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$ambiguityIdentity |
$authenticateResultInfo
$authenticateResultInfo : array
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$authenticateResultInfo |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$authenticateResultInfo |
$credential
$credential : mixed
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::$$credential |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$credential |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$credential |
$credentialColumns - columns to be used as the credentials
$credentialColumn : string
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$credentialColumn |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$credentialColumn |
$credentialTreatment - Treatment applied to the credential, such as MD5() or PASSWORD()
$credentialTreatment : string
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$credentialTreatment |
$dbSelect
$dbSelect : \Zend\Db\Sql\Select
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$dbSelect |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$dbSelect |
$identity
$identity : mixed
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::$$identity |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$identity |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$identity |
$identityColumn - the column to use as the identity
$identityColumn : string
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$identityColumn |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$identityColumn |
$resultRow - Results of database authentication query
$resultRow : array
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$resultRow |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$resultRow |
$tableName - the table name to check
$tableName : string
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$tableName |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$tableName |
Database Connection
$zendDb : \Zend\Db\Adapter\Adapter
Inherited
| inherited_from |
\Zend\Authentication\Adapter\DbTable\AbstractAdapter::$$zendDb |
| inherited_from |
\Zend\Authentication\Adapter\DbTable\CredentialTreatmentAdapter::$$zendDb |