Class: LiveUser_Auth_DB

Source Location: /LiveUser-0.16.5/Auth/DB.php

Class Overview

LiveUser_Auth_Common
   |
   --LiveUser_Auth_DB

DB container for Authentication

Author(s):

Markus Wolff <wolff at 21st.de>

Version:

Release: @package_version@

Copyright:

2002-2005 Markus Wolff

Inherited Variables

Class: LiveUser_Auth_Common

LiveUser_Auth_Common::$alias
LiveUser_Auth_Common::$allowDuplicateHandles
LiveUser_Auth_Common::$allowEmptyPasswords
LiveUser_Auth_Common::$backendArrayIndex
LiveUser_Auth_Common::$containerName
LiveUser_Auth_Common::$currentLogin
LiveUser_Auth_Common::$encryptionModes
LiveUser_Auth_Common::$expireTime
LiveUser_Auth_Common::$externalValues
LiveUser_Auth_Common::$fields
LiveUser_Auth_Common::$idleTime
LiveUser_Auth_Common::$loggedIn
LiveUser_Auth_Common::$loginTimeout
LiveUser_Auth_Common::$passwordEncryptionMode
LiveUser_Auth_Common::$propertyValues
LiveUser_Auth_Common::$secret
LiveUser_Auth_Common::$tables
LiveUser_Auth_Common::$updateLastLogin

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::externalValuesMatch(): Check if the stored external values match the current external values
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::init(): Load the storage container
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::setExternalValues(): Creates associative array of values from $externalValues['values'] with $keysToCheck
LiveUser_Auth_Common::unfreeze(): Reinitializes properties

Class Details

[line 77]
DB container for Authentication

This is a PEAR::DB backend driver for the LiveUser class. A PEAR::DB connection object can be passed to the constructor to reuse an existing connection. Alternatively, a DSN can be passed to open a new one.

Requirements:

File "LiveUser.php" (contains the parent class "LiveUser")
Array of connection options or a PEAR::DB connection object must be passed to the constructor. Example: array('dsn' => 'mysql://user:pass@host/db_name', 'connection => &$conn, # PEAR::DB connection object 'loginTimeout' => 0, 'allowDuplicateHandles' => 1);

Author: Markus Wolff <wolff@21st.de>
Version: Release: @package_version@
Copyright: 2002-2005 Markus Wolff
Link: http://pear.php.net/LiveUser
License: http://www.gnu.org/licenses/lgpl.txt

[ Top ]

Class Variables

$prefix = 'liveuser_'

[line 102]

Table prefix Prefix for all db tables the container has.

Access: public

Type:

string

[ Top ]

Method Detail

disconnect [line 252]

void disconnect(
)

Properly disconnect from database

Access: public

Overrides LiveUser_Auth_Common::disconnect() (properly disconnect from resources)

[ Top ]

init [line 113]

boolean init(
mixed
&$conf, string
$containerName)

Load the storage container

Return: true on success or false on failure
Access: public

Overrides LiveUser_Auth_Common::init() (Load the storage container)

Parameters:

mixed	`&$conf`	—	Name of array containing the configuration.
string	`$containerName`	—	name of the container that should be used

[ Top ]

readUserData [line 194]

boolean readUserData(
[string
$handle = ''], [boolean
$passwd = ''], [string
$auth_user_id = false])

Reads auth_user_id, passwd, is_active flag

lastlogin timestamp from the database If only $handle is given, it will read the data from the first user with that handle and return true on success. If $handle and $passwd are given, it will try to find the first user with both handle and password matching and return true on success (this allows multiple users having the same handle but different passwords - yep, some people want this). If no match is found, false is being returned.

Return: true upon success or false on failure
Access: public

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

Parameters:

string	`$handle`	—	user handle
boolean	`$passwd`	—	user password
string	`$auth_user_id`	—	auth user id

[ Top ]