Class: Auth_Container_Pear

Source Location: /Auth-1.6.4/Auth/Container/PEAR.php

Class Overview

Auth_Container
   |
   --Auth_Container_Pear

Storage driver for authenticating against PEAR website

Author(s):

Adam Harvey <aharvey at php.net>
Yavor Shahpasov <yavo at netsmart.com.cy>
Adam Ashley <aashley at php.net>

Version:

Release: @package_version@ File: $Revision: 289652 $

Copyright:

2001-2007 The PHP Group

Variables

$karma
$url

Methods

Inherited Variables

Class: Auth_Container

Auth_Container::$activeUser
Auth_Container::$_auth_obj

Inherited Methods

Class: Auth_Container

Auth_Container::Auth_Container(): Constructor
Auth_Container::addUser(): Add a new user to the storage container
Auth_Container::changePassword(): Change password for user in the storage container
Auth_Container::fetchData(): Fetch data from storage container
Auth_Container::getCryptType(): Returns the crypt current crypt type of the container
Auth_Container::getUser(): Returns a user assoc array
Auth_Container::listUsers(): List all users that are available from the storage container
Auth_Container::log(): Log a message to the Auth log
Auth_Container::removeUser(): Remove user from the storage container
Auth_Container::supportsChallengeResponse(): Returns true if the container supports Challenge Response
Auth_Container::verifyPassword(): Crypt and verfiy the entered password

Class Details

[line 57]
Storage driver for authenticating against PEAR website

This driver provides a method for authenticating against the pear.php.net authentication system.

Supports two options:

"url": The base URL with schema to authenticate against
"karma": An array of karma levels which the user needs one of. When empty, no karma level is required.

Author: Adam Harvey <aharvey@php.net>
Author: Yavor Shahpasov <yavo@netsmart.com.cy>
Author: Adam Ashley <aashley@php.net>
Version: Release: @package_version@ File: $Revision: 289652 $
Copyright: 2001-2007 The PHP Group
Link: http://pear.php.net/package/Auth
Since: Class available since Release 1.3.0
License: PHP License 3.01

[ Top ]

Class Variables

$karma = array()

[line 75]

Array of karma levels the user can have.

A user needs only one of the levels to succeed login. No levels mean that only username and password need to match

Type:

array

[ Top ]

$url = 'https://pear.php.net/rest-login.php/'

[line 66]

URL to connect to, with schema

Type:

string

[ Top ]

Method Detail

Auth_Container_Pear (Constructor) [line 89]

void Auth_Container_Pear(
[array
$data = null])

Constructor

Accepts options "url" and "karma", see class docs.

Parameters:

array $data — Array of options

[ Top ]

fetchData [line 120]

mixed fetchData(
string
$username, string
$password)

Get user information from pear.php.net

This function uses the given username and password to authenticate against the pear.php.net website

Return: Error object or boolean

Overrides Auth_Container::fetchData() (Fetch data from storage container)

Parameters:

string	`$username`	—	Username
string	`$password`	—	Password

[ Top ]