Class Zend_Auth

Description
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Auth.php (line 30)


	
			
Class Constant Summary
Variable Summary
Method Summary
 boolean getUseSession ()
 boolean isLoggedIn ()
 void logout ()
 void __construct (Zend_Auth_Adapter $adapter, [boolean $useSession = true], [string $sessionNamespace = self::SESSION_NAMESPACE_DEFAULT], [ $sessionTokenName = self::SESSION_TOKEN_NAME_DEFAULT], string $sessionToken)
 Zend_Auth setSessionNamespace (string $sessionNamespace)
 Zend_Auth setSessionTokenName (string $sessionTokenName)
 Zend_Auth setUseSession (booolean $useSession)
Variables
Zend_Auth_Adapter $_adapter (line 47)

Authentication adapter

  • access: protected
string $_sessionNamespace (line 61)

Session namespace used for storing authentication token

  • access: protected
mixed $_sessionTokenName (line 66)

Member name for authentication token

  • access: protected
boolean $_useSession (line 54)

Whether or not to automatically use the session for persisting authentication token

  • access: protected
Methods
authenticate (line 96)

Authenticates against the attached adapter

All parameters are passed along to the adapter's authenticate() method.

Zend_Auth_Token_Interface authenticate (array $options)
  • array $options
getSessionNamespace (line 137)

Returns the session namespace used for storing authentication token

  • access: public
string getSessionNamespace ()
getSessionTokenName (line 158)

Returns the name of the session object member where the authentication token is located

  • access: public
string getSessionTokenName ()
getToken (line 186)

Returns an existing authentication token from the session, or null if there is no token in the session

The location in the session of the token determined by the session namespace and token member name currently set for this object.

  • access: public
Zend_Auth_Token_Interface|null getToken ()
getUseSession (line 114)

Returns whether or not the session is used automatically

  • access: public
boolean getUseSession ()
isLoggedIn (line 203)

Returns true if and only if an existing authentication token exists at the location determined by the session namespace and token member name currently set for this object and the token represents a successful authentication attempt

  • access: public
boolean isLoggedIn ()
logout (line 217)

Removes an existing authentication token from the location determined by the session namespace and token member name currently set for this object

  • access: public
void logout ()
Constructor __construct (line 77)

Sets the authentication adapter

  • access: public
void __construct (Zend_Auth_Adapter $adapter, [boolean $useSession = true], [string $sessionNamespace = self::SESSION_NAMESPACE_DEFAULT], [ $sessionTokenName = self::SESSION_TOKEN_NAME_DEFAULT], string $sessionToken)
  • Zend_Auth_Adapter $adapter
  • boolean $useSession
  • string $sessionNamespace
  • string $sessionToken
  • $sessionTokenName
setSessionNamespace (line 148)

Sets the session namespace used for storing authentication token

  • return: Provides a fluent interface
  • access: public
Zend_Auth setSessionNamespace (string $sessionNamespace)
  • string $sessionNamespace
setSessionTokenName (line 169)

Sets the name of the session object member where the authentication token is located

  • return: Provides a fluent interface
  • access: public
Zend_Auth setSessionTokenName (string $sessionTokenName)
  • string $sessionTokenName
setUseSession (line 125)

Set whether or not to use the session automatically

  • return: Provides a fluent interface
  • access: public
Zend_Auth setUseSession (booolean $useSession)
  • booolean $useSession
Class Constants
SESSION_NAMESPACE_DEFAULT = 'Zend_Auth' (line 35)

Default session namespace

SESSION_TOKEN_NAME_DEFAULT = 'token' (line 40)

Default session variable name for authentication token

Documentation generated on Thu, 18 Jan 2007 10:00:40 -0800 by phpDocumentor 1.3.1