PHP Класс ZFExt_Auth_Adapter_Doctrine, ZFPlanet

Наследование: implements Zend_Auth_Adapter_Interface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_authenticateResultInfo array $_authenticateResultInfo
$_credential string $_credential - Credential values
$_credentialColumn string $_credentialColumns - columns to be used as the credentials
$_credentialTreatment string $_credentialTreatment - Treatment applied to the credential, such as MD5() or PASSWORD()
$_identity string $_identity - Identity value
$_identityColumn string $_identityColumn - the column to use as the identity
$_modelName string $_tableName - the table name to check
$_result array $_result - Results of database authentication query

Открытые методы

Метод Описание
__construct ( string $modelName = null, string $identityColumn = null, string $credentialColumn = null, string $credentialTreatment = null ) : void __construct() - Sets configuration options
authenticate ( ) : 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.
setCredential ( string $credential ) : ZFExt_Auth_Adapter_Doctrine 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(?)'
setCredentialColumn ( string $credentialColumn ) : ZFExt_Auth_Adapter_Doctrine setCredentialColumn() - set the column name to be used as the credential column
setCredentialTreatment ( string $treatment ) : ZFExt_Auth_Adapter_Doctrine setCredentialTreatment() - Sets a hash algorithm passed to PHP's hash() before the password is added to a SELECT query. The DB's expressions are not used (it's my class damn it! :p) since many are simply weak or inappropriate anyway.
setIdentity ( string $value ) : ZFExt_Auth_Adapter_Doctrine setIdentity() - set the value to be used as the identity
setIdentityColumn ( string $identityColumn ) : ZFExt_Auth_Adapter_Doctrine setIdentityColumn() - set the column name to be used as the identity column
setModelName ( string $modelName ) : ZFExt_Auth_Adapter_Doctrine setModelName() - set the model name to be used in the select query

Защищенные методы

Метод Описание
_authenticateCreateAuthResult ( ) : Zend_Auth_Result _authenticateCreateAuthResult() - Creates a Zend_Auth_Result object from the information that has been collected during the authenticate() attempt.
_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.
_authenticateValidateResultSet ( array $resultIdentities ) : true | Zend_Auth_Result _authenticateValidateResultSet() - This method attempts to make certain that only one record was returned in the resultset

Описание методов

__construct() публичный Метод

__construct() - Sets configuration options
public __construct ( string $modelName = null, string $identityColumn = null, string $credentialColumn = null, string $credentialTreatment = null ) : void
$modelName string
$identityColumn string
$credentialColumn string
$credentialTreatment string
Результат void

_authenticateCreateAuthResult() защищенный Метод

_authenticateCreateAuthResult() - Creates a Zend_Auth_Result object from the information that has been collected during the authenticate() attempt.
protected _authenticateCreateAuthResult ( ) : Zend_Auth_Result
Результат Zend_Auth_Result

_authenticateSetup() защищенный Метод

_authenticateSetup() - This method abstracts the steps involved with making sure that this adapter was indeed setup properly with all required pieces of information.
protected _authenticateSetup ( ) : true
Результат true

_authenticateValidateResultSet() защищенный Метод

_authenticateValidateResultSet() - This method attempts to make certain that only one record was returned in the resultset
protected _authenticateValidateResultSet ( array $resultIdentities ) : true | Zend_Auth_Result
$resultIdentities array
Результат true | Zend_Auth_Result

authenticate() публичный Метод

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.
public authenticate ( ) : Zend_Auth_Result
Результат Zend_Auth_Result

setCredential() публичный Метод

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(?)'
public setCredential ( string $credential ) : ZFExt_Auth_Adapter_Doctrine
$credential string
Результат ZFExt_Auth_Adapter_Doctrine Provides a fluent interface

setCredentialColumn() публичный Метод

setCredentialColumn() - set the column name to be used as the credential column
public setCredentialColumn ( string $credentialColumn ) : ZFExt_Auth_Adapter_Doctrine
$credentialColumn string
Результат ZFExt_Auth_Adapter_Doctrine Provides a fluent interface

setCredentialTreatment() публичный Метод

setCredentialTreatment() - Sets a hash algorithm passed to PHP's hash() before the password is added to a SELECT query. The DB's expressions are not used (it's my class damn it! :p) since many are simply weak or inappropriate anyway.
public setCredentialTreatment ( string $treatment ) : ZFExt_Auth_Adapter_Doctrine
$treatment string
Результат ZFExt_Auth_Adapter_Doctrine Provides a fluent interface

setIdentity() публичный Метод

setIdentity() - set the value to be used as the identity
public setIdentity ( string $value ) : ZFExt_Auth_Adapter_Doctrine
$value string
Результат ZFExt_Auth_Adapter_Doctrine Provides a fluent interface

setIdentityColumn() публичный Метод

setIdentityColumn() - set the column name to be used as the identity column
public setIdentityColumn ( string $identityColumn ) : ZFExt_Auth_Adapter_Doctrine
$identityColumn string
Результат ZFExt_Auth_Adapter_Doctrine Provides a fluent interface

setModelName() публичный Метод

setModelName() - set the model name to be used in the select query
public setModelName ( string $modelName ) : ZFExt_Auth_Adapter_Doctrine
$modelName string
Результат ZFExt_Auth_Adapter_Doctrine Provides a fluent interface

Описание свойств

$_authenticateResultInfo защищенное свойство

$_authenticateResultInfo
protected array $_authenticateResultInfo
Результат array

$_credential защищенное свойство

$_credential - Credential values
protected string $_credential
Результат string

$_credentialColumn защищенное свойство

$_credentialColumns - columns to be used as the credentials
protected string $_credentialColumn
Результат string

$_credentialTreatment защищенное свойство

$_credentialTreatment - Treatment applied to the credential, such as MD5() or PASSWORD()
protected string $_credentialTreatment
Результат string

$_identity защищенное свойство

$_identity - Identity value
protected string $_identity
Результат string

$_identityColumn защищенное свойство

$_identityColumn - the column to use as the identity
protected string $_identityColumn
Результат string

$_modelName защищенное свойство

$_tableName - the table name to check
protected string $_modelName
Результат string

$_result защищенное свойство

$_result - Results of database authentication query
protected array $_result
Результат array