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

Class: LiveUser_Auth_Session

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

Class Overview

LiveUser_Auth_Common
   |
   --LiveUser_Auth_Session

Session based container for Authentication


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2002-2006 Markus Wolff

Variables

Methods


Inherited Variables

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 65]
Session based container for Authentication

This is a backend driver for a simple session based anonymous LiveUser class.

Requirements:

  • File "LiveUser.php" (contains the parent class "LiveUser")



[ Top ]


Class Variables

$sessionKey =  'password'

[line 73]

name of the key containing the Session phrase inside the auth session array
  • Access: public

Type:   string


[ Top ]



Method Detail

init   [line 84]

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 114]

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

Reads user data from the given data source Compares $passwd with a string inside the $_SESSION array
  • 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 ]


Documentation generated on Fri, 15 Oct 2010 15:00:14 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.