API Documentation

Zend/Auth/Adapter/Digest.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Auth  
Subpackage
Adapter  
Version
$Id: Digest.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Auth_Adapter_Digest

Package: Zend\Auth\Adapter

Implements
\Zend_Auth_Adapter_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_filename= ''

Filename against which authentication queries are performed

Details
Type
string
Propertyprotectedstring  $_password= ''

Password for the user of the realm

Details
Type
string
Propertyprotectedstring  $_realm= ''

Digest authentication realm

Details
Type
string
Propertyprotectedstring  $_username= ''

Digest authentication user

Details
Type
string

Methods

methodpublic__construct( mixed $filename = null, mixed $realm = null, mixed $username = null, mixed $password = null ) : void

Sets adapter options

Parameters
Name Type Description
$filename mixed
$realm mixed
$username mixed
$password mixed
methodprotected_secureStringCompare( string $a, string $b ) : bool

Securely compare two strings for equality while avoided C level memcmp() optimisations capable of leaking timing information useful to an attacker attempting to iteratively guess the unknown string (e.g. password) being compared against.

Parameters
Name Type Description
$a string
$b string
Returns
Type Description
bool
methodpublicauthenticate( ) : \Zend_Auth_Result

Defined by Zend_Auth_Adapter_Interface

Returns
Type Description
\Zend_Auth_Result
Throws
Exception Description
\Zend_Auth_Adapter_Exception
methodpublicgetFilename( ) : string|null

Returns the filename option value or null if it has not yet been set

Returns
Type Description
string|null
methodpublicgetPassword( ) : string|null

Returns the password option value or null if it has not yet been set

Returns
Type Description
string|null
methodpublicgetRealm( ) : string|null

Returns the realm option value or null if it has not yet been set

Returns
Type Description
string|null
methodpublicgetUsername( ) : string|null

Returns the username option value or null if it has not yet been set

Returns
Type Description
string|null
methodpublicsetFilename( mixed $filename ) : \Zend_Auth_Adapter_Digest

Sets the filename option value

Parameters
Name Type Description
$filename mixed
Returns
Type Description
\Zend_Auth_Adapter_Digest Provides a fluent interface
methodpublicsetPassword( mixed $password ) : \Zend_Auth_Adapter_Digest

Sets the password option value

Parameters
Name Type Description
$password mixed
Returns
Type Description
\Zend_Auth_Adapter_Digest Provides a fluent interface
methodpublicsetRealm( mixed $realm ) : \Zend_Auth_Adapter_Digest

Sets the realm option value

Parameters
Name Type Description
$realm mixed
Returns
Type Description
\Zend_Auth_Adapter_Digest Provides a fluent interface
methodpublicsetUsername( mixed $username ) : \Zend_Auth_Adapter_Digest

Sets the username option value

Parameters
Name Type Description
$username mixed
Returns
Type Description
\Zend_Auth_Adapter_Digest Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.