Auth
[ class tree: Auth ] [ index: Auth ] [ all elements ]

Class: Auth_Container

Source Location: /Auth-1.6.4/Auth/Container.php

Class Overview


Storage class for fetching login data


Author(s):

Version:

  • Release: @package_version@ File: $Revision: 294935 $

Copyright:

  • 2001-2006 The PHP Group

Variables

Methods


Child classes:

Auth_Container_SMBPasswd
Storage driver for fetching login data from an SAMBA smbpasswd file.
Auth_Container_Multiple
Storage driver for using multiple storage drivers in a fall through fashion
Auth_Container_MDB2
Storage driver for fetching login data from a database
Auth_Container_LDAP
Storage driver for fetching login data from LDAP
Auth_Container_POP3
Storage driver for Authentication on a POP3 server.
Auth_Container_Pear
Storage driver for authenticating against PEAR website
Auth_Container_IMAP
Storage driver for fetching login data from an IMAP server
Auth_Container_File
Storage driver for fetching login data from an encrypted password file.
Auth_Container_SAP
Performs authentication against a SAP system using the SAPRFC PHP extension.
Auth_Container_DBLite
A lighter storage driver for fetching login data from a database
Auth_Container_vpopmail
Storage driver for fetching login data from vpopmail
Auth_Container_KADM5
Storage driver for Authentication on a Kerberos V server.
Auth_Container_MDB
Storage driver for fetching login data from a database
Auth_Container_RADIUS
Storage driver for authenticating users against RADIUS servers.
Auth_Container_Array
Storage driver for fetching authentication data from a PHP Array
Auth_Container_DB
Storage driver for fetching login data from a database
Auth_Container_SOAP5
Storage driver for fetching login data from SOAP using the PHP5 Builtin SOAP functions. This is a modification of the SOAP Storage driver from Bruno Pedro thats using the PEAR SOAP Package.
Auth_Container_Vpopmaild
Storage driver for Authentication on a Vpopmaild server.
Auth_Container_SOAP
Storage driver for fetching login data from SOAP

Inherited Variables

Inherited Methods


Class Details

[line 37]
Storage class for fetching login data


[ Top ]


Class Variables

$activeUser =  ""

[line 47]

User that is currently selected from the storage container.
  • Access: public

Type:   mixed


[ Top ]

$_auth_obj =  null

[line 54]

The Auth object this container is attached to.
  • Access: public

Type:   mixed


[ Top ]



Method Detail

Auth_Container (Constructor)   [line 66]

Auth_Container Auth_Container( )

Constructor

Has to be overwritten by each storage class

  • Access: public

[ Top ]

addUser   [line 199]

boolean addUser( string $username, string $password, [array $additional = null])

Add a new user to the storage container

Overridden in child classes as:

Auth_Container_SMBPasswd::addUser()
Add a new user to the storage container
Auth_Container_MDB2::addUser()
Add user to the storage container
Auth_Container_File::addUser()
Add a new user to the storage container
Auth_Container_MDB::addUser()
Add user to the storage container
Auth_Container_DB::addUser()
Add user to the storage container

Parameters:

string   $username   —  Username
string   $password   —  Password
array   $additional   —  Additional information

[ Top ]

changePassword   [line 228]

void changePassword( string $username, string $password)

Change password for user in the storage container

Overridden in child classes as:

Auth_Container_SMBPasswd::changePassword()
Change password for user in the storage container
Auth_Container_MDB2::changePassword()
Change password for user in the storage container
Auth_Container_File::changePassword()
Change password for user in the storage container
Auth_Container_MDB::changePassword()
Change password for user in the storage container
Auth_Container_DB::changePassword()
Change password for user in the storage container

Parameters:

string   $username   —  Username
string   $password   —  The new password

[ Top ]

fetchData   [line 80]

void fetchData( $username, $password, [ $isChallengeResponse = false])

Fetch data from storage container

Has to be overwritten by each storage class

  • Access: public

Overridden in child classes as:

Auth_Container_SMBPasswd::fetchData()
Get user information from pwfile
Auth_Container_Multiple::fetchData()
Get user information from array
Auth_Container_MDB2::fetchData()
Get user information from database
Auth_Container_LDAP::fetchData()
Fetch data from LDAP server
Auth_Container_POP3::fetchData()
Try to login to the POP3 server
Auth_Container_Pear::fetchData()
Get user information from pear.php.net
Auth_Container_IMAP::fetchData()
Try to open a IMAP stream using $username / $password
Auth_Container_File::fetchData()
Authenticate an user
Auth_Container_SAP::fetchData()
Performs username and password check
Auth_Container_DBLite::fetchData()
Get user information from database
Auth_Container_vpopmail::fetchData()
Get user information from vpopmail
Auth_Container_KADM5::fetchData()
Try to login to the KADM5 server
Auth_Container_MDB::fetchData()
Get user information from database
Auth_Container_RADIUS::fetchData()
Authenticate
Auth_Container_Array::fetchData()
Get user information from array
Auth_Container_DB::fetchData()
Get user information from database
Auth_Container_SOAP5::fetchData()
Fetch data from SOAP service
Auth_Container_Vpopmaild::fetchData()
fetchData()
Auth_Container_SOAP::fetchData()
Fetch data from SOAP service

Parameters:

   $username   — 
   $password   — 
   $isChallengeResponse   — 

[ Top ]

getCryptType   [line 145]

string getCryptType( )

Returns the crypt current crypt type of the container

Overridden in child classes as:

Auth_Container_MDB2::getCryptType()
Returns the selected crypt type for this container
Auth_Container_MDB::getCryptType()
Returns the selected crypt type for this container
Auth_Container_DB::getCryptType()
Returns the selected crypt type for this container

[ Top ]

getUser   [line 172]

void getUser( string $username)

Returns a user assoc array

Containers which want should overide this


Parameters:

string   $username   —  The username

[ Top ]

listUsers   [line 156]

void listUsers( )

List all users that are available from the storage container

Overridden in child classes as:

Auth_Container_SMBPasswd::listUsers()
Auth_Container_MDB2::listUsers()
Returns a list of users from the container
Auth_Container_File::listUsers()
List all available users
Auth_Container_MDB::listUsers()
Returns a list of users from the container
Auth_Container_Array::listUsers()
Returns a list of users available within the container
Auth_Container_DB::listUsers()
Returns a list of users from the container

[ Top ]

log   [line 244]

boolean log( string $message, [int $level = AUTH_LOG_DEBUG])

Log a message to the Auth log

Parameters:

string   $message   —  The message
int   $level   — 

[ Top ]

removeUser   [line 213]

void removeUser( string $username)

Remove user from the storage container

Overridden in child classes as:

Auth_Container_SMBPasswd::removeUser()
Remove user from the storage container
Auth_Container_MDB2::removeUser()
Remove user from the storage container
Auth_Container_File::removeUser()
Remove user from the storage container
Auth_Container_MDB::removeUser()
Remove user from the storage container
Auth_Container_DB::removeUser()
Remove user from the storage container

Parameters:

string   $username   —  Username

[ Top ]

supportsChallengeResponse   [line 132]

void supportsChallengeResponse( )

Returns true if the container supports Challenge Response

password authentication


Overridden in child classes as:

Auth_Container_MDB2::supportsChallengeResponse()
Determine if this container supports password authentication with challenge response
Auth_Container_MDB::supportsChallengeResponse()
Determine if this container supports password authentication with challenge response
Auth_Container_DB::supportsChallengeResponse()
Determine if this container supports password authentication with challenge response

[ Top ]

verifyPassword   [line 99]

bool verifyPassword( string $password1, string $password2, [string $cryptType = "md5"])

Crypt and verfiy the entered password
  • Return: True, if the passwords match

Parameters:

string   $password1   —  Entered password
string   $password2   —  Password from the data container (usually this password is already encrypted.
string   $cryptType   —  Type of algorithm with which the password from the container has been crypted. (md5, crypt etc.) Defaults to "md5".

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:41:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.