API Documentation

Auth.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Auth
version
$Id: Auth.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Auth

Description

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.

Zend_Auth
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Auth
Properties
$_instance
$_storage
Methods
__construct
__clone
getInstance
getStorage
setStorage
authenticate
hasIdentity
getIdentity
clearIdentity

Description

Properties

$_instance
jump to class

Zend_Auth $_instance = 'null'

Singleton instance

Details

$_instance
Zend_Auth
visibility
protected
default
null
final
false
static
true

$_storage
jump to class

Zend_Auth_Storage_Interface $_storage = 'null'

Persistent storage handler

Details

$_storage
Zend_Auth_Storage_Interface
visibility
protected
default
null
final
false
static
false

Methods

__clone
jump to class

__clone( ) : void

Singleton pattern implementation makes "clone" unavailable

Details
visibility
protected
final
false
static
false

__construct
jump to class

__construct( ) : void

Singleton pattern implementation makes "new" unavailable

Details
visibility
protected
final
false
static
false

authenticate
jump to class

authenticate( Zend_Auth_Adapter_Interface $adapter ) : Zend_Auth_Result

Authenticates against the supplied adapter

Arguments
$adapter
Zend_Auth_Adapter_Interface
Output
Zend_Auth_Result
Details
visibility
public
final
false
static
false

clearIdentity
jump to class

clearIdentity( ) : void

Clears the identity from persistent storage

Details
visibility
public
final
false
static
false

getIdentity
jump to class

getIdentity( ) : mixed|null

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

Output
mixed|null
Details
visibility
public
final
false
static
false

getInstance
jump to class

getInstance( ) : Zend_Auth

Returns an instance of Zend_Auth

Singleton pattern implementation

Output
Zend_Auth
Provides a fluent interface
Details
visibility
public
final
false
static
true

getStorage
jump to class

getStorage( ) : Zend_Auth_Storage_Interface

Returns the persistent storage handler

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

Output
Zend_Auth_Storage_Interface
Details
visibility
public
final
false
static
false

hasIdentity
jump to class

hasIdentity( ) : boolean

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

Output
boolean
Details
visibility
public
final
false
static
false

setStorage
jump to class

setStorage( Zend_Auth_Storage_Interface $storage ) : Zend_Auth

Sets the persistent storage handler

Arguments
$storage
Zend_Auth_Storage_Interface
Output
Zend_Auth
Provides a fluent interface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.