Methods
__construct() - Sets configuration options
__construct(\Zend\Db\Adapter\Adapter $zendDb, string $tableName, string $identityColumn, string $credentialColumn)
Parameters
$tableName
stringOptional
$identityColumn
stringOptional
$credentialColumn
stringOptional
This method is called to attempt an authentication.
authenticate() : \Zend\Authentication\Result
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.
Exceptions
Returns
getAmbiguityIdentity() - returns TRUE for usage of multiple identical
identities with different credentials, FALSE if not used.
getAmbiguityIdentity() : 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() |
Returns
mixed
getDbSelect() - Return the preauthentication Db Select object for userland select query modification
getDbSelect() : \Zend\Db\Sql\Select
Returns the identity of the account being authenticated, or
NULL if none is set.
getIdentity() : mixed
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::getIdentity() |
Returns
mixed
getResultRowObject() - Returns the result row as a stdClass object
getResultRowObject(string | array $returnColumns, string | array $omitColumns) : \stdClass | bool
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
It accepts integers (0, 1) or boolean (true,
false) parameters. Default is false.
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() |
Parameters
$credential
mixed
Returns
setCredentialColumn() - set the column name to be used as the credential column
setCredentialColumn(string $credentialColumn) : \Zend\Authentication\Adapter\DbTable\self
Parameters
$credentialColumn
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() |
Parameters
$identity
mixed
Returns
setIdentityColumn() - set the column name to be used as the identity column
setIdentityColumn(string $identityColumn) : \Zend\Authentication\Adapter\DbTable\self
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
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
_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
_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
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
_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
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
Parameters
$resultIdentities
array
Returns
Properties
$ambiguityIdentity - Flag to indicate same Identity can be used with
different credentials.
$ambiguityIdentity : bool
Default is FALSE and need to be set to true to
allow ambiguity usage.
$authenticateResultInfo
$authenticateResultInfo : array
$credential
$credential : mixed
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::$$credential |
$credentialColumns - columns to be used as the credentials
$credentialColumn : string
$identity
$identity : mixed
Inherited
| inherited_from |
\Zend\Authentication\Adapter\AbstractAdapter::$$identity |
$identityColumn - the column to use as the identity
$identityColumn : string
$resultRow - Results of database authentication query
$resultRow : array
$tableName - the table name to check
$tableName : string