API Documentation

Zend/Auth.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Auth  
Version
$Id: Auth.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Auth

Package: Zend\Auth

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Auth  $_instance= 'null'
static

Singleton instance

Default valuenullDetails
Type
\Zend_Auth
Propertyprotected\Zend_Auth_Storage_Interface  $_storage= 'null'

Persistent storage handler

Default valuenullDetails
Type
\Zend_Auth_Storage_Interface

Methods

methodprotected__clone( ) : void

Singleton pattern implementation makes "clone" unavailable

methodprotected__construct( ) : void

Singleton pattern implementation makes "new" unavailable

methodpublicauthenticate( \Zend_Auth_Adapter_Interface $adapter ) : \Zend_Auth_Result

Authenticates against the supplied adapter

Parameters
Name Type Description
$adapter \Zend_Auth_Adapter_Interface
Returns
Type Description
\Zend_Auth_Result
methodpublicclearIdentity( ) : void

Clears the identity from persistent storage

methodpublicgetIdentity( ) : mixed|null

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

Returns
Type Description
mixed|null
methodpublicgetInstance( ) : \Zend_Auth
static

Returns an instance of Zend_Auth

Singleton pattern implementation

Returns
Type Description
\Zend_Auth Provides a fluent interface
methodpublicgetStorage( ) : \Zend_Auth_Storage_Interface

Returns the persistent storage handler

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

Returns
Type Description
\Zend_Auth_Storage_Interface
methodpublichasIdentity( ) : boolean

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

Returns
Type Description
boolean
methodpublicsetStorage( \Zend_Auth_Storage_Interface $storage ) : \Zend_Auth

Sets the persistent storage handler

Parameters
Name Type Description
$storage \Zend_Auth_Storage_Interface
Returns
Type Description
\Zend_Auth Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.