Zend Framework  3.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ApacheResolver Class Reference

Apache Authentication Resolver. More...

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, $password=null)
 Resolve credentials.
 

Protected Member Functions

 getApachePassword ()
 Returns the Apache Password object.
 

Protected Attributes

 $file
 
 $apachePassword
 

Detailed Description

Apache Authentication Resolver.

See Also
http://httpd.apache.org/docs/2.2/misc/password_encryptions.html

Constructor & Destructor Documentation

__construct (   $path = '')

Constructor.

Parameters
string$pathComplete filename where the credentials are stored

Member Function Documentation

getApachePassword ( )
protected

Returns the Apache Password object.

Returns
ApachePassword
getFile ( )

Returns the path to the credentials file.

Returns
string
resolve (   $username,
  $realm,
  $password = null 
)

Resolve credentials.

Parameters
string$usernameUsername
string$realmAuthentication Realm
string$passwordThe password to authenticate
Returns
AuthResult
Exceptions
Exception\ExceptionInterface

Implements ResolverInterface.

setFile (   $path)

Set the path to the credentials file.

Parameters
string$path
Returns
self Provides a fluent interface
Exceptions
Exception\InvalidArgumentExceptionif path is not readable

Member Data Documentation

$apachePassword
protected
$file
protected