Zend Framework  1.12
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Zend_Auth Class Reference

Public Member Functions

 getStorage ()
 Returns the persistent storage handler.
 
 setStorage (Zend_Auth_Storage_Interface $storage)
 Sets the persistent storage handler.
 
 authenticate (Zend_Auth_Adapter_Interface $adapter)
 Authenticates against the supplied adapter.
 
 hasIdentity ()
 Returns true if and only if an identity is available from storage.
 
 getIdentity ()
 Returns the identity from storage or null if no identity is available.
 
 clearIdentity ()
 Clears the identity from persistent storage.
 

Static Public Member Functions

static getInstance ()
 Returns an instance of Zend_Auth.
 

Protected Member Functions

 __construct ()
 Singleton pattern implementation makes "new" unavailable.
 
 __clone ()
 Singleton pattern implementation makes "clone" unavailable.
 

Protected Attributes

 $_storage = null
 

Static Protected Attributes

static $_instance = null
 

Constructor & Destructor Documentation

__construct ( )
protected

Singleton pattern implementation makes "new" unavailable.

Returns
void

Member Function Documentation

__clone ( )
protected

Singleton pattern implementation makes "clone" unavailable.

Returns
void
authenticate ( Zend_Auth_Adapter_Interface  $adapter)

Authenticates against the supplied adapter.

Parameters
Zend_Auth_Adapter_Interface$adapter
Returns
Zend_Auth_Result

ZF-7546 - prevent multiple succesive calls from storing inconsistent results Ensure storage has clean state

clearIdentity ( )

Clears the identity from persistent storage.

Returns
void
getIdentity ( )

Returns the identity from storage or null if no identity is available.

Returns
mixed|null
static getInstance ( )
static

Returns an instance of Zend_Auth.

Singleton pattern implementation

Returns
Zend_Auth Provides a fluent interface
getStorage ( )

Returns the persistent storage handler.

Session storage is used by default unless a different storage adapter has been set.

Returns
Zend_Auth_Storage_Interface
See Also
Zend_Auth_Storage_Session
hasIdentity ( )

Returns true if and only if an identity is available from storage.

Returns
boolean
setStorage ( Zend_Auth_Storage_Interface  $storage)

Sets the persistent storage handler.

Parameters
Zend_Auth_Storage_Interface$storage
Returns
Zend_Auth Provides a fluent interface

Member Data Documentation

$_instance = null
staticprotected
$_storage = null
protected