API Documentation

Zend/Auth/Adapter/DbTable.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Auth  
Subpackage
Adapter  
Version
$Id: DbTable.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Auth_Adapter_DbTable

Package: Zend\Auth\Adapter

Implements
\Zend_Auth_Adapter_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedboolean  $_ambiguityIdentity= 'false'

$_ambiguityIdentity - Flag to indicate same Identity can be used with different credentials. Default is FALSE and need to be set to true to allow ambiguity usage.

Default valuefalseDetails
Type
boolean
Propertyprotectedarray  $_authenticateResultInfo= 'null'

$_authenticateResultInfo

Default valuenullDetails
Type
array
Propertyprotectedstring  $_credential= 'null'

$_credential - Credential values

Default valuenullDetails
Type
string
Propertyprotectedstring  $_credentialColumn= 'null'

$_credentialColumns - columns to be used as the credentials

Default valuenullDetails
Type
string
Propertyprotectedstring  $_credentialTreatment= 'null'

$_credentialTreatment - Treatment applied to the credential, such as MD5() or PASSWORD()

Default valuenullDetails
Type
string
Propertyprotected\Zend_Db_Select  $_dbSelect= 'null'

Default valuenullDetails
Type
\Zend_Db_Select
Propertyprotectedstring  $_identity= 'null'

$_identity - Identity value

Default valuenullDetails
Type
string
Propertyprotectedstring  $_identityColumn= 'null'

$_identityColumn - the column to use as the identity

Default valuenullDetails
Type
string
Propertyprotectedarray  $_resultRow= 'null'

$_resultRow - Results of database authentication query

Default valuenullDetails
Type
array
Propertyprotectedstring  $_tableName= 'null'

$_tableName - the table name to check

Default valuenullDetails
Type
string
Propertyprotected\Zend_Db_Adapter_Abstract  $_zendDb= 'null'

Database Connection

Default valuenullDetails
Type
\Zend_Db_Adapter_Abstract

Methods

methodpublic__construct( \Zend_Db_Adapter_Abstract $zendDb = null, string $tableName = null, string $identityColumn = null, string $credentialColumn = null, string $credentialTreatment = null ) : void

__construct() - Sets configuration options

Parameters
Name Type Description
$zendDb \Zend_Db_Adapter_Abstract

If null, default database adapter assumed

$tableName string
$identityColumn string
$credentialColumn string
$credentialTreatment string
methodprotected_authenticateCreateAuthResult( ) : \Zend_Auth_Result

_authenticateCreateAuthResult() - Creates a Zend_Auth_Result object from the information that has been collected during the authenticate() attempt.

Returns
Type Description
\Zend_Auth_Result
methodprotected_authenticateCreateSelect( ) : \Zend_Db_Select

_authenticateCreateSelect() - This method creates a Zend_Db_Select object that is completely configured to be queried against the database.

Returns
Type Description
\Zend_Db_Select
methodprotected_authenticateQuerySelect( \Zend_Db_Select $dbSelect ) : array

_authenticateQuerySelect() - This method accepts a Zend_Db_Select object and performs a query against the database with that object.

Parameters
Name Type Description
$dbSelect \Zend_Db_Select
Returns
Type Description
array
Throws
Exception Description
\Zend_Auth_Adapter_Exception - when an invalid select object is encountered
methodprotected_authenticateSetup( ) : true

_authenticateSetup() - This method abstracts the steps involved with making sure that this adapter was indeed setup properly with all required pieces of information.

Returns
Type Description
true
Throws
Exception Description
\Zend_Auth_Adapter_Exception - in the event that setup was not done properly
methodprotected_authenticateValidateResult( array $resultIdentity ) : \Zend_Auth_Result

_authenticateValidateResult() - This method attempts to validate that the record in the resultset is indeed a record that matched the identity provided to this adapter.

Parameters
Name Type Description
$resultIdentity array
Returns
Type Description
\Zend_Auth_Result
methodprotected_authenticateValidateResultSet( array $resultIdentities ) : true|\Zend_Auth_Result

_authenticateValidateResultSet() - This method attempts to make certain that only one record was returned in the resultset

Parameters
Name Type Description
$resultIdentities array
Returns
Type Description
true|\Zend_Auth_Result
methodprotected_setDbAdapter(  $zendDb = null ) : \Zend_Auth_Adapter_DbTable

_setDbAdapter() - set the database adapter to be used for quering

Parameters
Name Type Description
$zendDb

Zend_Db_Adapter_Abstract

Returns
Type Description
\Zend_Auth_Adapter_DbTable
Throws
Exception Description
\Zend_Auth_Adapter_Exception
methodpublicauthenticate( ) : \Zend_Auth_Result

authenticate() - defined by Zend_Auth_Adapter_Interface. 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
Type Description
\Zend_Auth_Result
Throws
Exception Description
\Zend_Auth_Adapter_Exception if answering the authentication query is impossible
methodpublicgetAmbiguityIdentity( ) : bool

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

Returns
Type Description
bool
methodpublicgetDbSelect( ) : \Zend_Db_Select

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

Returns
Type Description
\Zend_Db_Select
methodpublicgetResultRowObject( string|array $returnColumns = null, string|array $omitColumns = null ) : \stdClass|boolean

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

Parameters
Name Type Description
$returnColumns string|array
$omitColumns string|array
Returns
Type Description
\stdClass|boolean
methodpublicsetAmbiguityIdentity( int|bool $flag ) : \Zend_Auth_Adapter_DbTable

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.

Parameters
Name Type Description
$flag int|bool
Returns
Type Description
\Zend_Auth_Adapter_DbTable
methodpublicsetCredential( string $credential ) : \Zend_Auth_Adapter_DbTable

setCredential() - set the credential value to be used, optionally can specify a treatment to be used, should be supplied in parameterized form, such as 'MD5(?)' or 'PASSWORD(?)'

Parameters
Name Type Description
$credential string
Returns
Type Description
\Zend_Auth_Adapter_DbTable Provides a fluent interface
methodpublicsetCredentialColumn( string $credentialColumn ) : \Zend_Auth_Adapter_DbTable

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

Parameters
Name Type Description
$credentialColumn string
Returns
Type Description
\Zend_Auth_Adapter_DbTable Provides a fluent interface
methodpublicsetCredentialTreatment( string $treatment ) : \Zend_Auth_Adapter_DbTable

setCredentialTreatment() - allows the developer to pass a parameterized 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 parameterized treatment string with this method, a developer may apply arbitrary SQL upon input credential data.

Examples:

'PASSWORD(?)' 'MD5(?)'

Parameters
Name Type Description
$treatment string
Returns
Type Description
\Zend_Auth_Adapter_DbTable Provides a fluent interface
methodpublicsetIdentity( string $value ) : \Zend_Auth_Adapter_DbTable

setIdentity() - set the value to be used as the identity

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Auth_Adapter_DbTable Provides a fluent interface
methodpublicsetIdentityColumn( string $identityColumn ) : \Zend_Auth_Adapter_DbTable

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

Parameters
Name Type Description
$identityColumn string
Returns
Type Description
\Zend_Auth_Adapter_DbTable Provides a fluent interface
methodpublicsetTableName( string $tableName ) : \Zend_Auth_Adapter_DbTable

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

Parameters
Name Type Description
$tableName string
Returns
Type Description
\Zend_Auth_Adapter_DbTable Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.