__construct() - Sets configuration options
Parameters: |
|
---|---|
Return type: | ZendAuthenticationAdapterDbTable |
setTableName() - set the table name to be used in the select query
Parameters: | string – |
---|---|
Return type: | DbTable Provides a fluent interface |
setIdentityColumn() - set the column name to be used as the identity column
Parameters: | string – |
---|---|
Return type: | DbTable Provides a fluent interface |
setCredentialColumn() - set the column name to be used as the credential column
Parameters: | string – |
---|---|
Return type: | DbTable Provides a fluent interface |
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(?)’
Parameters: | string – |
---|---|
Return type: | DbTable Provides a fluent interface |
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: | int|bool – |
---|---|
Return type: | DbTable Provides a fluent interface |
getAmbiguityIdentity() - returns TRUE for usage of multiple identical identities with different credentials, FALSE if not used.
Return type: | bool |
---|
getDbSelect() - Return the preauthentication Db Select object for userland select query modification
Return type: | DbSelect |
---|
getResultRowObject() - Returns the result row as a stdClass object
Parameters: |
|
---|---|
Return type: | stdClass|bool |
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.
Return type: | AuthenticationResult |
---|
_authenticateSetup() - This method abstracts the steps involved with making sure that this adapter was indeed setup properly with all required pieces of information.
Return type: | bool |
---|
_authenticateCreateSelect() - This method creates a ZendDbSqlSelect object that is completely configured to be queried against the database.
Return type: | DbSelect |
---|
_authenticateQuerySelect() - This method accepts a ZendDbSqlSelect object and performs a query against the database with that object.
Parameters: | DbSelect – |
---|---|
Throws ExceptionRuntimeException: | |
when an invalid select object is encountered | |
Return type: | array |
_authenticateValidateResultSet() - This method attempts to make certain that only one record was returned in the resultset
Parameters: | array – |
---|---|
Return type: | bool|ZendAuthenticationResult |