Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

Zend_Auth Class Reference

Public Member Functions

 getStorage ()
 setStorage (Zend_Auth_Storage_Interface $storage)
 authenticate (Zend_Auth_Adapter_Interface $adapter)
 hasIdentity ()
 getIdentity ()
 clearIdentity ()

Static Public Member Functions

static getInstance ()

Protected Member Functions

 __construct ()
 __clone ()

Protected Attributes

 $_storage = null

Static Protected Attributes

static $_instance = null

Detailed Description

Definition at line 29 of file Auth.php.


Constructor & Destructor Documentation

__construct (  ) [protected]

Singleton pattern implementation makes "new" unavailable

Returns:
void

Definition at line 50 of file Auth.php.


Member Function Documentation

__clone (  ) [protected]

Singleton pattern implementation makes "clone" unavailable

Returns:
void

Definition at line 58 of file Auth.php.

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

Definition at line 115 of file Auth.php.

clearIdentity (  )

Clears the identity from persistent storage

Returns:
void

Definition at line 165 of file Auth.php.

getIdentity (  )

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

Returns:
mixed|null

Definition at line 149 of file Auth.php.

static getInstance (  ) [static]

Returns an instance of Zend_Auth

Singleton pattern implementation

Returns:
Zend_Auth Provides a fluent interface

Definition at line 68 of file Auth.php.

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

Definition at line 84 of file Auth.php.

hasIdentity (  )

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

Returns:
boolean

Definition at line 139 of file Auth.php.

setStorage ( Zend_Auth_Storage_Interface $  storage )

Sets the persistent storage handler

Parameters:
Zend_Auth_Storage_Interface$storage
Returns:
Zend_Auth Provides a fluent interface

Definition at line 103 of file Auth.php.


The documentation for this class was generated from the following file: