Summary

Fully Qualified Name:	Laminas\Authentication\Adapter\DbTable
Extends:	CredentialTreatmentAdapter

Description

Methods

Name	Description	Defined By
__construct()	__construct() - Sets configuration options	CredentialTreatmentAdapter
authenticate()	This method is called to attempt an authentication. 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.	AbstractAdapter
getAmbiguityIdentity()	getAmbiguityIdentity() - returns TRUE for usage of multiple identical identities with different credentials, FALSE if not used.	AbstractAdapter
getCredential()	Returns the credential of the account being authenticated, or NULL if none is set.	AbstractAdapter
getDbSelect()	getDbSelect() - Return the preauthentication Db Select object for userland select query modification	AbstractAdapter
getIdentity()	Returns the identity of the account being authenticated, or NULL if none is set.	AbstractAdapter
getResultRowObject()	getResultRowObject() - Returns the result row as a stdClass object	AbstractAdapter
setAmbiguityIdentity()	setAmbiguityIdentity() - sets a flag for usage of identical identities with unique credentials. It accepts integers (0, 1) or boolean (true, false) parameters. Default is false.	AbstractAdapter
setCredential()	Sets the credential for binding	AbstractAdapter
setCredentialColumn()	setCredentialColumn() - set the column name to be used as the credential column	AbstractAdapter
setCredentialTreatment()	setCredentialTreatment() - allows the developer to pass a parametrized string that is used to transform or treat the input credential data.	CredentialTreatmentAdapter
setIdentity()	Sets the identity for binding	AbstractAdapter
setIdentityColumn()	setIdentityColumn() - set the column name to be used as the identity column	AbstractAdapter
setTableName()	setTableName() - set the table name to be used in the select query	AbstractAdapter

Method Details

__construct()

__construct() - Sets configuration options

Parameter Name	Type	Description
$laminasDb	\DbAdapter
$tableName	string	Optional
$identityColumn	string	Optional
$credentialColumn	string	Optional
$credentialTreatment	string	Optional

Returns:

authenticate()

This method is called to attempt an authentication. 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.

Returns: \AuthenticationResult

getAmbiguityIdentity()

getAmbiguityIdentity() - returns TRUE for usage of multiple identical identities with different credentials, FALSE if not used.

Returns: bool

getCredential()

Returns the credential of the account being authenticated, or NULL if none is set.

Returns: mixed

getDbSelect()

getDbSelect() - Return the preauthentication Db Select object for userland select query modification

Returns: \Sql\Select

getIdentity()

Returns the identity of the account being authenticated, or NULL if none is set.

Returns: mixed

getResultRowObject()

getResultRowObject() - Returns the result row as a stdClass object

Parameter Name	Type	Description
$returnColumns	string|array
$omitColumns	string|array

Returns: \stdClass|bool

setAmbiguityIdentity()

setAmbiguityIdentity() - sets a flag for usage of identical identities with unique credentials. It accepts integers (0, 1) or boolean (true, false) parameters. Default is false.

Parameter Name	Type	Description
$flag	int|bool

Returns: self Provides a fluent interface

setCredential()

Sets the credential for binding

Parameter Name	Type	Description
$credential	mixed

Returns: self Provides a fluent interface

setCredentialColumn()

setCredentialColumn() - set the column name to be used as the credential column

Parameter Name	Type	Description
$credentialColumn	string

Returns: self Provides a fluent interface

setCredentialTreatment()

setCredentialTreatment() - allows the developer to pass a parametrized string that is used to transform or treat the input credential data.

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(?)'

Parameter Name	Type	Description
$treatment	string

Returns: self Provides a fluent interface

setIdentity()

Sets the identity for binding

Parameter Name	Type	Description
$identity	mixed

Returns: self Provides a fluent interface

setIdentityColumn()

setIdentityColumn() - set the column name to be used as the identity column

Parameter Name	Type	Description
$identityColumn	string

Returns: self Provides a fluent interface

setTableName()

setTableName() - set the table name to be used in the select query

Parameter Name	Type	Description
$tableName	string

Returns: self Provides a fluent interface