Class Zend_Auth_Adapter_DbTable

Description

Implements interfaces:

  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Auth/Adapter/DbTable.php (line 44)


	
			
Variable Summary
Method Summary
 void __construct ( $zendDb, [string $tableName = null], [string $identityColumn = null], [string $credentialColumn = null], [string $credentialTreatment = null])
 stdClass getResultRowObject ([string|array $returnColumns = null], [string|array $omitColumns = null])
 Zend_Auth_Adapter_DbTable setCredentialColumn (string $credentialColumn)
 Zend_Auth_Adapter_DbTable setIdentityColumn (string $identityColumn)
Variables
string $_credential = null (line 86)

$_credential - Credential values

  • access: protected
string $_credentialColumn = null (line 72)

$_credentialColumns - columns to be used as the credentials

  • access: protected
string $_credentialTreatment = null (line 93)

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

  • access: protected
string $_identity = null (line 79)

$_identity - Identity value

  • access: protected
string $_identityColumn = null (line 65)

$_identityColumn - the column to use as the identity

  • access: protected
array $_resultRow = null (line 100)

$_resultRow - Results of database authentication query

  • access: protected
string $_tableName = null (line 58)

$_tableName - the table name to check

  • access: protected
Zend_Db_Adapter_Abstract $_zendDb = null (line 51)

Database Connection

  • access: protected
Methods
Constructor __construct (line 112)

__construct() - Sets configuration options

  • access: public
void __construct ( $zendDb, [string $tableName = null], [string $identityColumn = null], [string $credentialColumn = null], [string $credentialTreatment = null])
  • Zend_Db_Adapter_Abstract $zendDb
  • string $tableName
  • string $identityColumn
  • string $credentialColumn
  • string $credentialTreatment
authenticate (line 265)

authenticate() - defined by Zend_Auth_Adapter_Interface.

  • throws: Zend_Auth_Adapter_Exception if answering the authentication query is impossible
  • access: public
Zend_Auth_Result authenticate ()

Implementation of:
Zend_Auth_Adapter_Interface::authenticate()
Performs an authentication attempt
getResultRowObject (line 225)

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

  • access: public
stdClass getResultRowObject ([string|array $returnColumns = null], [string|array $omitColumns = null])
  • string|array $returnColumns
  • string|array $omitColumns
setCredential (line 212)

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

  • access: public
Zend_Auth_Adapter_DbTable setCredential (string $credential)
  • string $credential
setCredentialColumn (line 164)

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

  • access: public
Zend_Auth_Adapter_DbTable setCredentialColumn (string $credentialColumn)
  • string $credentialColumn
setCredentialTreatment (line 187)

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

  • access: public
Zend_Auth_Adapter_DbTable setCredentialTreatment (string $treatment)
  • string $treatment
setIdentity (line 199)

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

  • access: public
Zend_Auth_Adapter_DbTable setIdentity (string $value)
  • string $value
setIdentityColumn (line 152)

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

  • access: public
Zend_Auth_Adapter_DbTable setIdentityColumn (string $identityColumn)
  • string $identityColumn
setTableName (line 140)

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

  • access: public
Zend_Auth_Adapter_DbTable setTableName (string $tableName)
  • string $tableName

Documentation generated on Sun, 27 May 2007 23:22:26 -0700 by phpDocumentor 1.3.2