Class Zend_Auth_Adapter_Http_Resolver_File

Description

Implements interfaces:

HTTP Authentication File Resolver

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

Located in /Auth/Adapter/Http/Resolver/File.php (line 40)


	
			
Variable Summary
 string $_file
Method Summary
 void __construct ([string $path = ''])
 string getFile ()
 string|false resolve (string $username, string $realm)
Variables
string $_file (line 47)

Path to credentials file

  • access: protected
Methods
Constructor __construct (line 55)

Constructor

  • access: public
void __construct ([string $path = ''])
  • string $path: Complete filename where the credentials are stored
getFile (line 88)

Returns the path to the credentials file

  • access: public
string getFile ()
resolve (line 114)

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.

  • return: User's shared secret, if the user is found in the realm, false otherwise.
  • throws: Zend_Auth_Adapter_Http_Resolver_Exception
  • access: public
string|false resolve (string $username, string $realm)
  • string $username: Username
  • string $realm: Authentication Realm

Implementation of:
Zend_Auth_Adapter_Http_Resolver_Interface::resolve()
Resolve username/realm to password/hash/etc.
setFile (line 69)

Set the path to the credentials file

  • return: Provides a fluent interface
  • throws: Zend_Auth_Adapter_Http_Resolver_Exception
  • access: public
Zend_Auth_Adapter_Http_Resolver_File setFile (string $path)
  • string $path

Documentation generated on Sun, 27 May 2007 23:23:52 -0700 by phpDocumentor 1.3.2