Auth/Adapter/Digest.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Auth
subpackage: Adapter
version: $Id: Digest.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Auth_Adapter_Digest

Description

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.

Zend_Auth_Adapter_Digest
jump to top

Implements: Zend_Auth_Adapter_Interface
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Auth
subpackage: Adapter
Properties: $_filename; $_realm; $_username; $_password
Methods: __construct; getFilename; setFilename; getRealm; setRealm; getUsername; setUsername; getPassword; setPassword; authenticate

Description

Properties

$_filename
jump to class

string $_filename = ''

Filename against which authentication queries are performed

Details

$_filename: string
visibility: protected
default
final: false
static: false

$_password
jump to class

string $_password = ''

Password for the user of the realm

Details

$_password: string
visibility: protected
default
final: false
static: false

$_realm
jump to class

string $_realm = ''

Digest authentication realm

Details

$_realm: string
visibility: protected
default
final: false
static: false

$_username
jump to class

string $_username = ''

Digest authentication user

Details

$_username: string
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

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

Sets adapter options

Arguments

$filename: mixed
$realm: mixed
$username: mixed
$password: mixed

Details

visibility: public
final: false
static: false

authenticate
jump to class

authenticate(
          
          )
        
        :
        Zend_Auth_Result

Defined by Zend_Auth_Adapter_Interface

Output

Zend_Auth_Result

Details

visibility: public
final: false
static: false
throws

getFilename
jump to class

getFilename(
          
          )
        
        :
        string|null

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

Output

string|null

Details

visibility: public
final: false
static: false

getPassword
jump to class

getPassword(
          
          )
        
        :
        string|null

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

Output

string|null

Details

visibility: public
final: false
static: false

getRealm
jump to class

getRealm(
          
          )
        
        :
        string|null

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

Output

string|null

Details

visibility: public
final: false
static: false

getUsername
jump to class

getUsername(
          
          )
        
        :
        string|null

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

Output

string|null

Details

visibility: public
final: false
static: false

setFilename
jump to class

setFilename(
          mixed $filename
          )
        
        :
        Zend_Auth_Adapter_Digest

Sets the filename option value

Arguments

$filename: mixed

Output

Zend_Auth_Adapter_Digest: Provides a fluent interface

Details

visibility: public
final: false
static: false

setPassword
jump to class

setPassword(
          mixed $password
          )
        
        :
        Zend_Auth_Adapter_Digest

Sets the password option value

Arguments

$password: mixed

Output

Zend_Auth_Adapter_Digest: Provides a fluent interface

Details

visibility: public
final: false
static: false

setRealm
jump to class

setRealm(
          mixed $realm
          )
        
        :
        Zend_Auth_Adapter_Digest

Sets the realm option value

Arguments

$realm: mixed

Output

Zend_Auth_Adapter_Digest: Provides a fluent interface

Details

visibility: public
final: false
static: false

setUsername
jump to class

setUsername(
          mixed $username
          )
        
        :
        Zend_Auth_Adapter_Digest

Sets the username option value

Arguments

$username: mixed

Output

Zend_Auth_Adapter_Digest: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Auth/Adapter/Digest.php

Description

Zend_Auth_Adapter_Digestjump to top

Description

Properties

$_filenamejump to class

Details

$_passwordjump to class

Details

$_realmjump to class

Details

$_usernamejump to class

Details

Methods

__constructjump to class

Arguments

Details

authenticatejump to class

Output

Details

getFilenamejump to class

Output

Details

getPasswordjump to class

Output

Details

getRealmjump to class

Output

Details

getUsernamejump to class

Output

Details

setFilenamejump to class

Arguments

Output

Details

setPasswordjump to class

Arguments

Output

Details

setRealmjump to class

Arguments

Output

Details

setUsernamejump to class

Arguments

Output

Details

Zend_Auth_Adapter_Digest
jump to top

$_filename
jump to class

$_password
jump to class

$_realm
jump to class

$_username
jump to class

__construct
jump to class

authenticate
jump to class

getFilename
jump to class

getPassword
jump to class

getRealm
jump to class

getUsername
jump to class

setFilename
jump to class

setPassword
jump to class

setRealm
jump to class

setUsername
jump to class