\Zend_Auth

Summary

Methods
Properties
Constants
getInstance()
getStorage()
setStorage()
authenticate()
hasIdentity()
getIdentity()
clearIdentity()
No public properties found
No constants found
__construct()
__clone()
$_instance
$_storage
N/A
No private methods found
No private properties found
N/A

Properties

$_instance

$_instance : \Zend_Auth

Singleton instance

Type

\Zend_Auth

$_storage

$_storage : \Zend_Auth_Storage_Interface

Persistent storage handler

Type

\Zend_Auth_Storage_Interface

Methods

getInstance()

getInstance() : \Zend_Auth

Returns an instance of Zend_Auth

Singleton pattern implementation

Returns

\Zend_Auth

Provides a fluent interface

getStorage()

getStorage() : \Zend_Auth_Storage_Interface

Returns the persistent storage handler

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

Returns

\Zend_Auth_Storage_Interface

setStorage()

setStorage(\Zend_Auth_Storage_Interface  $storage) : \Zend_Auth

Sets the persistent storage handler

Parameters

\Zend_Auth_Storage_Interface $storage

Returns

\Zend_Auth

Provides a fluent interface

authenticate()

authenticate(\Zend_Auth_Adapter_Interface  $adapter) : \Zend_Auth_Result

Authenticates against the supplied adapter

Parameters

\Zend_Auth_Adapter_Interface $adapter

Returns

\Zend_Auth_Result

hasIdentity()

hasIdentity() : boolean

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

Returns

boolean

getIdentity()

getIdentity() : mixed|null

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

Returns

mixed|null

clearIdentity()

clearIdentity() : void

Clears the identity from persistent storage

__construct()

__construct() : void

Singleton pattern implementation makes "new" unavailable

__clone()

__clone() : void

Singleton pattern implementation makes "clone" unavailable