Class: LiveUser_Auth_XML

Source Location: /LiveUser-0.16.14/LiveUser/Auth/XML.php

Class Overview

LiveUser_Auth_Common
   |
   --LiveUser_Auth_XML

XML driver for authentication

Author(s):

krausbn at php.net>

Version:

Release: @package_version@

Copyright:

2002-2006 Markus Wolff

Inherited Variables

Class: LiveUser_Auth_Common

LiveUser_Auth_Common::$alias
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::$handles
LiveUser_Auth_Common::$idleTime
LiveUser_Auth_Common::$loggedIn
LiveUser_Auth_Common::$passwordEncryptionMode
LiveUser_Auth_Common::$propertyValues
LiveUser_Auth_Common::$secret
LiveUser_Auth_Common::$stack
LiveUser_Auth_Common::$tables

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.
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::login(): Tries to make a login with the given handle and password.
LiveUser_Auth_Common::readUserData(): Reads user data from the given data source If only $handle is given, it will read the data from the first user with that handle and return true on success.
LiveUser_Auth_Common::setExternalValues(): Creates associative array of values from $externalValues['values'] with $keysToCheck
LiveUser_Auth_Common::unfreeze(): Reinitializes properties

Class Details

[line 66]
XML driver for authentication

This is a XML backend driver for the LiveUser class.

Author: krausbn@php.net>
Version: Release: @package_version@
Copyright: 2002-2006 Markus Wolff
Link: http://pear.php.net/LiveUser
License: http://www.gnu.org/licenses/lgpl.txt

[ Top ]

Method Detail

disconnect [line 268]

bool disconnect(
)

Properly disconnect from resources

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

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

[ Top ]

init [line 102]

bool init(
array
&$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:

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

[ Top ]

readUserData [line 209]

bool readUserData(
[string
$handle = ''], [string
$passwd = ''], [bool|int
$auth_user_id = false])

Reads user data from the given data source 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 only an auth_user_id is passed it will try to read the data based on the id If no match is found, false is being returned.

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

Overrides LiveUser_Auth_Common::readUserData() (Reads user data from the given data source If only $handle is given, it will read the data from the first user with that handle and return true on success.)

Parameters:

string	`$handle`	—	user handle
string	`$passwd`	—	user password
bool\|int	`$auth_user_id`	—	if the user data should be read using the auth user id

[ Top ]