Docs For Class Auth

$expire = 0

[line 48]

Auth lifetime in seconds

If this variable is set to 0, auth never expires

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

Type:

integer

[ Top ]

$expired = false

[line 56]

Has the auth session expired?

See: checkAuth(), drawLogin()

Type:

bool

[ Top ]

$idle = 0

[line 68]

Maximum time of idleness in seconds

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

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

Type:

integer

[ Top ]

$idled = false

[line 76]

Is the maximum idletime over?

See: checkAuth(), drawLogin();

Type:

boolean

[ Top ]

$loginCallback = ''

[line 128]

See: Auth::setLoginCallback()

Type:

string

[ Top ]

$loginFailedCallback = ''

[line 136]

Failed Login callback function name

See: setLoginFailedCallback()

Type:

string

[ Top ]

$loginFunction = ''

[line 91]

Function defined by the user, that creates the login screen

Type:

string

[ Top ]

$logoutCallback = ''

[line 144]

Logout callback function name

See: Auth::setLogoutCallback()

Type:

string

[ Top ]

$password = ''

[line 120]

Password

Type:

string

[ Top ]

$showLogin = true

[line 99]

Should the login form be displayed?

See: setShowlogin()

Type:

bool

[ Top ]

$status = ''

[line 106]

Current authentication status

Type:

string

[ Top ]

$storage = ''

[line 84]

Storage object

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

Type:

object

[ Top ]

$username = ''

[line 113]

Username

Type:

string

[ Top ]

$version = "@version@"

[line 158]

Package Version

Type:

string

[ Top ]

Auth (Constructor) [line 176]

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

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 ]

getAuth [line 587]

bool getAuth(
)

Has the user been authenticated?

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

[ Top ]

getAuthData [line 473]

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

string getStatus(
)

Get the current status

Access: public

[ Top ]

getUsername [line 713]

string getUsername(
)

Get the username

Access: public

[ Top ]

listUsers [line 764]

array listUsers(
)

List all users that are currently available in the storage container

Access: public

[ Top ]

logout [line 670]

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

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

integer sessionValidThru(
)

Returns the time up to the session is valid

Access: public

[ Top ]

setAuth [line 505]

void setAuth(
string
$username)

Access: public

Parameters:

string $username — Username

[ Top ]

setAuthData [line 450]

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

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

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

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

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

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

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

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

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

$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 176]

Parameters:

addUser [line 782]

Parameters:

getAuth [line 587]

getAuthData [line 473]

Parameters:

getStatus [line 731]

getUsername [line 713]

listUsers [line 764]

logout [line 670]

removeUser [line 798]

Parameters:

sessionValidThru [line 745]

setAuth [line 505]

Parameters:

setAuthData [line 450]

Parameters:

setExpire [line 332]

Parameters:

setFailedLoginCallback [line 417]

Parameters:

setIdle [line 352]

Parameters:

setLoginCallback [line 404]

Parameters:

setLogoutCallback [line 431]

Parameters:

setSessionname [line 375]

Parameters:

setShowLogin [line 390]

Parameters:

start [line 262]