Auth_Container_Array Class Reference

Inheritance diagram for Auth_Container_Array:

Collaboration diagram for Auth_Container_Array:

Public Member Functions
	Auth_Container_Array ($data)
	Constructor for Array Container. More...
	fetchData ($user, $pass)
	Get user information from array. More...
	listUsers ()
	Returns a list of users available within the container. More...
Public Member Functions inherited from Auth_Container
	Auth_Container ()
	Constructor. More...
	fetchData ($username, $password, $isChallengeResponse=false)
	Fetch data from storage container. More...
	verifyPassword ($password1, $password2, $cryptType="md5")
	Crypt and verfiy the entered password. More...
	supportsChallengeResponse ()
	Returns true if the container supports Challenge Response password authentication. More...
	getCryptType ()
	Returns the crypt current crypt type of the container. More...
	listUsers ()
	List all users that are available from the storage container. More...
	getUser ($username)
	Returns a user assoc array. More...
	addUser ($username, $password, $additional=null)
	Add a new user to the storage container. More...
	removeUser ($username)
	Remove user from the storage container. More...
	changePassword ($username, $password)
	Change password for user in the storage container. More...
	log ($message, $level=AUTH_LOG_DEBUG)
	Log a message to the Auth log. More...
Public Member Functions inherited from ilAuthContainerBase
	loginObserver ($a_username, $a_auth)
	Called after successful login. More...
	failedLoginObserver ($a_username, $a_auth)
	Called after failed login. More...
	checkAuthObserver ($a_username, $a_auth)
	Called after check auth requests. More...
	logoutObserver ($a_username, $a_auth)
	Called after logout. More...
	supportsCaptchaVerification ()
	Returns whether or not the auth container supports the verification of captchas This should be true for those auth methods, which are available in the default login form. More...

Data Fields
	$users
	The users and their password to authenticate against. More...
	$cryptType = 'none'
	The cryptType used on the passwords. More...
Data Fields inherited from Auth_Container
	$activeUser = ""
	User that is currently selected from the storage container. More...
	$_auth_obj = null
	The Auth object this container is attached to. More...

Detailed Description

Definition at line 71 of file Array.php.

Member Function Documentation

Auth_Container_Array()

Auth_Container_Array::Auth_Container_Array

(

$data

)

Constructor for Array Container.

Parameters

array

$data

Options for the container

Returns

void

Definition at line 98 of file Array.php.

References $data, and PEAR\raiseError().

    {
        if (!is_array($data)) {
            PEAR::raiseError('The options for Auth_Container_Array must be an array');
        }
        if (isset($data['users']) && is_array($data['users'])) {
            $this->users = $data['users'];
        } else {
            $this->users = array();
            PEAR::raiseError('Auth_Container_Array: no user data found in options array');
        }
        if (isset($data['cryptType'])) {
            $this->cryptType = $data['cryptType'];
        }
    }

Here is the call graph for this function:

fetchData()

Auth_Container_Array::fetchData	(		$user,
			$pass
	)

Get user information from array.

This function uses the given username to fetch the corresponding login data from the array. If an account that matches the passed username and password is found, the function returns true. Otherwise it returns false.

Parameters

string	Username
string	Password

Returns

boolean|PEAR_Error Error object or boolean

Definition at line 129 of file Array.php.

References $pass, AUTH_LOG_DEBUG, Auth_Container\log(), and Auth_Container\verifyPassword().

    {
        $this->log('Auth_Container_Array::fetchData() called.', AUTH_LOG_DEBUG);
        if (   isset($this->users[$user])
            && $this->verifyPassword($pass, $this->users[$user], $this->cryptType)) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

listUsers()

Auth_Container_Array::listUsers

(

)

Returns a list of users available within the container.

Returns

array

Definition at line 147 of file Array.php.

References $ret, AUTH_LOG_DEBUG, and Auth_Container\log().

    {
        $this->log('Auth_Container_Array::listUsers() called.', AUTH_LOG_DEBUG);
        $ret = array();
        foreach ($this->users as $username => $password) {
            $ret[]['username'] = $username;
        }
        return $ret;
    }

Here is the call graph for this function:

Field Documentation

$cryptType

string Auth_Container_Array::$cryptType = 'none'

The cryptType used on the passwords.

Definition at line 87 of file Array.php.

$users

array Auth_Container_Array::$users

The users and their password to authenticate against.

Definition at line 80 of file Array.php.

---

The documentation for this class was generated from the following file:

• Services/PEAR/lib/Auth/Container/Array.php