Class: Auth_Container_File

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

Class Overview

Auth_Container
   |
   --Auth_Container_File

Storage driver for fetching login data from an encrypted password file.

Author(s):

Adam Ashley <aashley at php.net>
Martin Jansen <mj at php.net>
Stefan Ekman <stekman at sedata.org>
Mika Tuupola <tuupola at appelsiini.net>
Michael Wallner <mike at php.net>

Version:

Release: @package_version@ File: $Revision: 237449 $

Copyright:

2001-2006 The PHP Group

Variables

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 58]
Storage driver for fetching login data from an encrypted password file.

This storage container can handle CVS pserver style passwd files.

Author: Adam Ashley <aashley@php.net>
Author: Martin Jansen <mj@php.net>
Author: Stefan Ekman <stekman@sedata.org>
Author: Mika Tuupola <tuupola@appelsiini.net>
Author: Michael Wallner <mike@php.net>
Version: Release: @package_version@ File: $Revision: 237449 $
Copyright: 2001-2006 The PHP Group
Link: http://pear.php.net/package/Auth
License: PHP License 3.01

[ Top ]

Class Variables

$options = array()

[line 75]

Options for container

Type:

array

[ Top ]

$pwfile = ''

[line 68]

Path to passwd file

Type:

string

[ Top ]

Method Detail

Auth_Container_File (Constructor) [line 86]

object Auth_Container_File Auth_Container_File(
string
$filename)

Constructor of the container class

Return: new Auth_Container_File object

Parameters:

string $filename — path to passwd file

[ Top ]

addUser [line 159]

boolean addUser(
string
$user, string
$pass, [mixed
$additional = ''])

Add a new user to the storage container

Overrides Auth_Container::addUser() (Add a new user to the storage container)

Parameters:

string	`$user`	—	username
string	`$pass`	—	password
mixed	`$additional`	—	Additional parameters to File_Password_*::addUser()

[ Top ]

changePassword [line 228]

void changePassword(
string
$username, string
$password)

Change password for user in the storage container

Overrides Auth_Container::changePassword() (Change password for user in the storage container)

Parameters:

string	`$username`	—	Username
string	`$password`	—	The new password

[ Top ]

fetchData [line 108]

mixed fetchData(
string
$user, string
$pass)

Authenticate an user

Return: boolean|PEAR_Error

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

Parameters:

string	`$user`	—	username
string	`$pass`	—	password

[ Top ]

listUsers [line 122]

array listUsers(
)

List all available users

Overrides Auth_Container::listUsers() (List all users that are available from the storage container)

[ Top ]

removeUser [line 198]

boolean removeUser(
string
$user)

Remove user from the storage container

Overrides Auth_Container::removeUser() (Remove user from the storage container)

Parameters:

string $user — Username

[ Top ]