Auth.php

Show:

inherited

Classes
- \Zend_Auth

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 24593 2012-01-05 20:35:02Z matthew $

\Zend_Auth
jump to top

Package: Zend\Auth

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

Properties

\Zend_Auth $_instance = null

static

Singleton instance

Default valuenullDetails

Type: \Zend_Auth

\Zend_Auth_Storage_Interface $_storage = null

Persistent storage handler

Default valuenullDetails

Type: \Zend_Auth_Storage_Interface

Methods

__clone() : void

Singleton pattern implementation makes "clone" unavailable

__construct() : void

Singleton pattern implementation makes "new" unavailable

authenticate(\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

clearIdentity() : void

Clears the identity from persistent storage

getIdentity() : mixed | null

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

Returns

Type	Description
mixed \| null

getInstance() : \Zend_Auth

static

Returns an instance of Zend_Auth

Singleton pattern implementation

Returns

Type	Description
\Zend_Auth	Provides a fluent interface

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

Type	Description
\Zend_Auth_Storage_Interface

hasIdentity() : boolean

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

Returns

Type	Description
boolean

setStorage(\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

Auth.php

\Zend_Authjump to top

Properties

Methods

\Zend_Auth
jump to top