Docs For Class Auth

$advancedsecurity = false

[line 169]

Flag to use advanced security When set extra checks will be made to see if the user's IP or useragent have changed across requests.

Turned off by default to preserve BC.

Type:

boolean

[ Top ]

$authdata =

[line 189]

A hash to hold various superglobals as reference

Type:

array

[ Top ]

$expire = 0

[line 49]

Auth lifetime in seconds

If this variable is set to 0, auth never expires

See: Auth::setExpire(), checkAuth()

Type:

integer

[ Top ]

$expired = false

[line 57]

Has the auth session expired?

See: checkAuth(), drawLogin()

Type:

bool

[ Top ]

$idle = 0

[line 69]

Maximum idletime in seconds

The difference to $expire is, that the idletime gets refreshed each time checkAuth() is called. If this variable is set to 0, idletime is never checked.

See: Auth::setIdle(), checkAuth()

Type:

integer

[ Top ]

$idled = false

[line 77]

Is the maximum idletime over?

See: checkAuth(), drawLogin();

Type:

boolean

[ Top ]

$loginCallback = ''

[line 129]

See: Auth::setLoginCallback()

Type:

string

[ Top ]

$loginFailedCallback = ''

[line 137]

Failed Login callback function name

See: setLoginFailedCallback()

Type:

string

[ Top ]

$loginFunction = ''

[line 92]

User-defined function that creates the login screen

Type:

string

[ Top ]

$logoutCallback = ''

[line 145]

Logout callback function name

See: Auth::setLogoutCallback()

Type:

string

[ Top ]

$password = ''

[line 121]

Password

Type:

string

[ Top ]

$showLogin = true

[line 100]

Should the login form be displayed, and are users allowed to authenticate via this page?

See: setShowlogin()

Type:

bool

[ Top ]

$status = ''

[line 107]

Current authentication status

Type:

string

[ Top ]

$storage = ''

[line 85]

Storage object

See: Auth::Auth(), validateLogin()

Type:

object

[ Top ]

$username = ''

[line 114]

Username

Type:

string

[ Top ]

$version = "@version@"

[line 159]

Package Version

Type:

string

[ Top ]

Auth (Constructor) [line 207]

void Auth(
string
$storageDriver, [mixed
$options = ''], [string
$loginFunction = ''], [boolean
$showLogin = true])

Constructor

Set up the storage driver.

Parameters:

string	`$storageDriver`	—	Type of the storage driver
mixed	`$options`	—	Additional options for the storage driver (example: if you are using DB as the storage driver, you have to pass the dsn string here)
string	`$loginFunction`	—	Name of the function that creates the login form
boolean	`$showLogin`	—	Should the login form be displayed if neccessary?

[ Top ]

addUser [line 860]

mixed addUser(
string
$username, string
$password, [mixed
$additional = ''])

Add user to the storage container

Return: True on success, PEAR error object on error and AUTH_METHOD_NOT_SUPPORTED otherwise.
Access: public

Parameters:

string	`$username`	—	Username
string	`$password`	—	Password
mixed	`$additional`	—	Additional parameters

[ Top ]

changePassword [line 893]

mixed changePassword(
string
$username, string
$password)

Change password for user in the storage container

Return: True on success, PEAR error object on error and AUTH_METHOD_NOT_SUPPORTED otherwise.
Access: public

Parameters:

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

[ Top ]

getAuth [line 662]

bool getAuth(
)

Has the user been authenticated?

Return: True if the user is logged in, otherwise false.
Access: public

[ Top ]

getAuthData [line 518]

mixed getAuthData(
[string
$name = null])

Get additional information that is stored in the session.

If no value for the first parameter is passed, the method will return all data that is currently stored.

Return: Value of the data field.
Access: public

Parameters:

string $name — Name of the data field

[ Top ]

getStatus [line 809]

string getStatus(
)

Get the current status

Access: public

[ Top ]

getUsername [line 791]

string getUsername(
)

Get the username

Access: public

[ Top ]

listUsers [line 842]

array listUsers(
)

List all users that are currently available in the storage container

Access: public

[ Top ]

logout [line 747]

void logout(
)

Logout function

This function clears any auth tokens in the currently active session and executes the logout callback function, if any

Access: public

[ Top ]

removeUser [line 876]

mixed removeUser(
string
$username)

Remove user from the storage container

Return: True on success, PEAR error object on error and AUTH_METHOD_NOT_SUPPORTED otherwise.
Access: public

Parameters:

string $username — Username

[ Top ]

sessionValidThru [line 823]

integer sessionValidThru(
)

Returns the time up to the session is valid

Access: public

[ Top ]

setAdvancedSecurity [line 577]

void setAdvancedSecurity(
[
$flag = true])

Parameters:

$flag —

[ Top ]

setAuth [line 550]

void setAuth(
string
$username)

Access: public

Parameters:

string $username — Username

[ Top ]

setAuthData [line 495]

void setAuthData(
string
$name, mixed
$value, [boolean
$overwrite = true])

Access: public

Parameters:

string	`$name`	—	Name of the data field
mixed	`$value`	—	Value of the data field
boolean	`$overwrite`	—	Should existing data be overwritten? (default is true)

[ Top ]

setExpire [line 377]

void setExpire(
integer
$time, [bool
$add = false])

Set the maximum expire time

Access: public

Parameters:

integer	`$time`	—	time in seconds
bool	`$add`	—	add time to current expire time or not

[ Top ]

setFailedLoginCallback [line 462]

void setFailedLoginCallback(
string
$loginFailedCallback)

The function will receive a single parameter, the username and a reference to the auth object.

Access: public

Parameters:

string $loginFailedCallback — callback function name

[ Top ]

setIdle [line 397]

void setIdle(
integer
$time, [bool
$add = false])

Set the maximum idle time

Access: public

Parameters:

integer	`$time`	—	time in seconds
bool	`$add`	—	add time to current maximum idle time or not

[ Top ]

setLoginCallback [line 449]

void setLoginCallback(
string
$loginCallback)

The function will receive two parameters, the username and a reference to the auth object.

See: Auth::setLogoutCallback()
Access: public

Parameters:

string $loginCallback — callback function name

[ Top ]

setLogoutCallback [line 476]

void setLogoutCallback(
string
$logoutCallback)

The function will receive three parameters, the username and a reference to the auth object.

See: Auth::setLoginCallback()
Access: public

Parameters:

string $logoutCallback — callback function name

[ Top ]

setSessionname [line 420]

void setSessionname(
[string
$name = 'PHPSESSID'])

Set name of the session to a customized value.

If you are using multiple instances of PEAR::Auth on the same domain, you can change the name of session per application via this function.

Access: public

Parameters:

string $name — New name for the session

[ Top ]

setShowLogin [line 435]

void setShowLogin(
[bool
$showLogin = true])

Should the login form be displayed if neccessary?

Access: public

Parameters:

bool $showLogin — show login form or not

[ Top ]

start [line 306]

void start(
)

Start new auth session

Access: public

[ Top ]

Class: Auth

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$advancedsecurity = false

$authdata =

$expire = 0

$expired = false

$idle = 0

$idled = false

$loginCallback = ''

$loginFailedCallback = ''

$loginFunction = ''

$logoutCallback = ''

$password = ''

$showLogin = true

$status = ''

$storage = ''

$username = ''

$version = "@version@"

Method Detail

Auth (Constructor) [line 207]

Parameters:

addUser [line 860]

Parameters:

changePassword [line 893]

Parameters:

getAuth [line 662]

getAuthData [line 518]

Parameters:

getStatus [line 809]

getUsername [line 791]

listUsers [line 842]

logout [line 747]

removeUser [line 876]

Parameters:

sessionValidThru [line 823]

setAdvancedSecurity [line 577]

Parameters:

setAuth [line 550]

Parameters:

setAuthData [line 495]

Parameters:

setExpire [line 377]

Parameters:

setFailedLoginCallback [line 462]

Parameters:

setIdle [line 397]

Parameters:

setLoginCallback [line 449]

Parameters:

setLogoutCallback [line 476]

Parameters:

setSessionname [line 420]

Parameters:

setShowLogin [line 435]

Parameters:

start [line 306]