Class: LiveUser_Auth_Container_PEAR_Auth

Source Location: /LiveUser-0.11.0/Auth/Container/PEAR_Auth.php

Class Overview

LiveUser_Auth_Common
   |
   --LiveUser_Auth_Container_PEAR_Auth

Class LiveUser_Auth_Container_PEAR_Auth

Author(s):

Bjoern Kraus <krausbn at php.net>

Version:

$Id: PEAR_Auth.php,v 1.4 2004/03/08 19:58:24 lsmith Exp $

Inherited Variables

Class: LiveUser_Auth_Common

LiveUser_Auth_Common::$allowDuplicateHandles
LiveUser_Auth_Common::$authUserId
LiveUser_Auth_Common::$backendArrayIndex
LiveUser_Auth_Common::$currentLogin
LiveUser_Auth_Common::$encryptionModes
LiveUser_Auth_Common::$expireTime
LiveUser_Auth_Common::$handle
LiveUser_Auth_Common::$idleTime
LiveUser_Auth_Common::$init_ok
LiveUser_Auth_Common::$isActive
LiveUser_Auth_Common::$lastLogin
LiveUser_Auth_Common::$loggedIn
LiveUser_Auth_Common::$loginTimeout
LiveUser_Auth_Common::$passwd
LiveUser_Auth_Common::$passwordEncryptionMode

Inherited Methods

Class: LiveUser_Auth_Common

LiveUser_Auth_Common::LiveUser_Auth_Common(): Class constructor. Feel free to override in backend subclasses.
LiveUser_Auth_Common::decryptPW(): Decrypts a password so that it can be compared with the user input. Uses the algorithm defined in the passwordEncryptionMode property.
LiveUser_Auth_Common::disconnect(): properly disconnect from resources
LiveUser_Auth_Common::encryptPW(): Encrypts a password for storage in a backend container.
LiveUser_Auth_Common::freeze(): store all properties in an array
LiveUser_Auth_Common::getProperty(): Function returns the inquired value if it exists in the class.
LiveUser_Auth_Common::isNewLogin(): Checks if there's enough time between lastLogin and current login (now) to count as a new login.
LiveUser_Auth_Common::login(): Tries to make a login with the given handle and password.
LiveUser_Auth_Common::readUserData(): Reads auth_user_id, passwd, is_active flag
LiveUser_Auth_Common::unfreeze(): Reinitializes properties
LiveUser_Auth_Common::updateUserData(): Writes current values for user back to the database.
LiveUser_Auth_Common::userExists(): Helper function that checks if there is a user in the database who's matching the given parameters.

Class Details

[line 88]
Class LiveUser_Auth_Container_PEAR_Auth

==================== !!! WARNING !!! ========================================

THIS CONTAINER IS UNDER HEAVY DEVELOPMENT. IT'S STILL IN EXPERIMENTAL STAGE. USE IT AT YOUR OWN RISK.

=============================================================================

Description: This is a PEAR::Auth backend driver for the LiveUser class. The general options to setup the PEAR::Auth class can be passed to the constructor. To choose the right auth container, you have to add the 'pearAuthContainer' var to the options array.

Requirements:

File "LoginManager.php" (contains the parent class "LiveUser")
PEAR::Auth must be installed in your PEAR directory
Array of setup options must be passed to the constructor. Example: $conf = array( 'authContainers' => array( 'DB' => array( 'type' => 'DB', 'name' => 'DB_Local', 'loginTimeout' => 0, 'expireTime' => 3600, 'idleTime' => 1800, 'dsn' => $dsn_lu, 'allowDuplicateHandles' => 0, 'authTable' => 'liveuser_users', 'authTableCols' => array( 'user_id' => 'auth_user_id', 'handle' => 'handle', 'passwd' => 'passwd', 'lastlogin' => 'lastlogin', 'is_active' => 'is_active' ) ), 'LDAP' => array( 'type' => 'PEAR_Auth', 'pearAuthContainer' => 'LDAP', 'host' => 'mein.ldap.server.de', 'port' => '389', 'basedn' => 'dc=company,dc=com', 'userattr' => 'uid', 'useroc' => 'person' ) ) );

Author: Bjoern Kraus <krausbn@php.net>
Version: $Id: PEAR_Auth.php,v 1.4 2004/03/08 19:58:24 lsmith Exp $

[ Top ]

Class Variables

$pearAuth = null

[line 95]

Contains the PEAR::Auth object.

Type:

object

[ Top ]

Method Detail

LiveUser_Auth_Container_PEAR_Auth (Constructor) [line 104]

LiveUser_Auth_Container_PEAR_Auth &LiveUser_Auth_Container_PEAR_Auth(
mixed
&$connectOptions)

LiveUser_Auth_Container_PEAR_Auth::LiveUser_Auth_Container_Auth()

Class constructor.

Parameters:

mixed &$connectOptions —

[ Top ]

freeze [line 128]

void freeze(
)

LiveUser_Auth_Container_PEAR_Auth::freeze()

Access: public

Overrides LiveUser_Auth_Common::freeze() (store all properties in an array)

[ Top ]

readUserData [line 138]

boolean readUserData(
)

LiveUser_Auth_Container_PEAR_Auth::readUserData()

Overrides LiveUser_Auth_Common::readUserData() (Reads auth_user_id, passwd, is_active flag)

[ Top ]

unfreeze [line 118]

void unfreeze(

&$connectOptions, mixed
$connectOptions)

LiveUser_Auth_Container_PEAR_Auth::unfreeze()

Access: public

Overrides LiveUser_Auth_Common::unfreeze() (Reinitializes properties)

Parameters:

mixed	`$connectOptions`	—
	`&$connectOptions`	—

[ Top ]

updateUserData [line 163]

boolean updateUserData(
)

LiveUser_Auth_Container_PEAR_Auth::updateUserData()

Overrides LiveUser_Auth_Common::updateUserData() (Writes current values for user back to the database.)

[ Top ]