Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Auth_Adapter_Http_Resolver_File Class Reference

Public Member Functions

 __construct ($path= '')
 Constructor.
 
 setFile ($path)
 Set the path to the credentials file.
 
 getFile ()
 Returns the path to the credentials file.
 
 resolve ($username, $realm)
 Resolve credentials.
 

Protected Attributes

 $_file
 

Constructor & Destructor Documentation

__construct (   $path = '')

Constructor.

Parameters
string$pathComplete filename where the credentials are stored
Returns
void

Member Function Documentation

getFile ( )

Returns the path to the credentials file.

Returns
string
resolve (   $username,
  $realm 
)

Resolve credentials.

Only the first matching username/realm combination in the file is returned. If the file contains credentials for Digest authentication, the returned string is the password hash, or h(a1) from RFC 2617. The returned string is the plain-text password for Basic authentication.

The expected format of the file is: username:realm:sharedSecret

That is, each line consists of the user's username, the applicable authentication realm, and the password or hash, each delimited by colons.

Parameters
string$usernameUsername
string$realmAuthentication Realm
Exceptions
Zend_Auth_Adapter_Http_Resolver_Exception
Returns
string|false User's shared secret, if the user is found in the realm, false otherwise.
See Also
Zend_Auth_Adapter_Http_Resolver_Exception
Zend_Auth_Adapter_Http_Resolver_Exception
Zend_Auth_Adapter_Http_Resolver_Exception
Zend_Auth_Adapter_Http_Resolver_Exception
Zend_Auth_Adapter_Http_Resolver_Exception

Implements Zend_Auth_Adapter_Http_Resolver_Interface.

setFile (   $path)

Set the path to the credentials file.

Parameters
string$path
Exceptions
Zend_Auth_Adapter_Http_Resolver_Exception
Returns
Zend_Auth_Adapter_Http_Resolver_File Provides a fluent interface
See Also
Zend_Auth_Adapter_Http_Resolver_Exception

Member Data Documentation

$_file
protected