Docs For Class Auth

$advancedsecurity = false

[line 201]

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 ]

$allowLogin = true

[line 132]

Is Login Allowed from this page

See: Auth::setAllowLogin()

Type:

bool

[ Top ]

$authChecks = 0

[line 251]

How many times has checkAuth been called

var int

Type:

mixed

[ Top ]

$authdata =

[line 245]

A hash to hold various superglobals as reference

Type:

array

[ Top ]

$cookie =

[line 239]

Holds a reference to the global cookie variable

Type:

array

[ Top ]

$expire = 0

[line 73]

Auth lifetime in seconds

If this variable is set to 0, auth never expires

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

Type:

integer

[ Top ]

$expired = false

[line 81]

Has the auth session expired?

See: Auth::checkAuth()

Type:

bool

[ Top ]

$idle = 0

[line 93]

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(), Auth::checkAuth()

Type:

integer

[ Top ]

$idled = false

[line 101]

Is the maximum idletime over?

See: Auth::checkAuth()

Type:

boolean

[ Top ]

$loginCallback = ''

[line 161]

See: Auth::setLoginCallback()

Type:

string

[ Top ]

$loginFailedCallback = ''

[line 169]

Failed Login callback function name

See: Auth::setFailedLoginCallback()

Type:

string

[ Top ]

$loginFunction = ''

[line 116]

User-defined function that creates the login screen

Type:

string

[ Top ]

$logoutCallback = ''

[line 177]

Logout callback function name

See: Auth::setLogoutCallback()

Type:

string

[ Top ]

$password = ''

[line 153]

Password

Type:

string

[ Top ]

$post =

[line 233]

Holds a reference to the global post variable

Type:

array

[ Top ]

$server =

[line 227]

Holds a reference to the global server variable

Type:

array

[ Top ]

$session =

[line 221]

Holds a reference to the session auth variable

Type:

array

[ Top ]

$showLogin = true

[line 124]

Should the login form be displayed

See: setShowlogin()

Type:

bool

[ Top ]

$status = ''

[line 139]

Current authentication status

Type:

string

[ Top ]

$storage = ''

[line 109]

Storage object

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

Type:

object

[ Top ]

$username = ''

[line 146]

Username

Type:

string

[ Top ]

$version = "@version@"

[line 191]

Package Version

Type:

string

[ Top ]

Auth (Constructor) [line 270]

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

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

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 ]

checkAuth [line 773]

boolean checkAuth(
)

Checks if there is a session with valid auth information.

Return: Whether or not the user is authenticated.
Access: public

[ Top ]

getAuth [line 883]

bool getAuth(
)

Has the user been authenticated?

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

[ Top ]

getAuthData [line 683]

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 ]

getPostPasswordField [line 981]

string getPostPasswordField(
)

Gets the post varible used for the username

Access: public

[ Top ]

getPostUsernameField [line 967]

string getPostUsernameField(
)

Gets the post varible used for the username

Access: public

[ Top ]

getStatus [line 953]

string getStatus(
)

Get the current status

Access: public

[ Top ]

getUsername [line 936]

string getUsername(
)

Get the username

Access: public

[ Top ]

listUsers [line 1016]

array listUsers(
)

List all users that are currently available in the storage container

Access: public

[ Top ]

logout [line 901]

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

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

integer sessionValidThru(
)

Returns the time up to the session is valid

Access: public

[ Top ]

setAdvancedSecurity [line 759]

void setAdvancedSecurity(
[bool
$flag = true])

Enables advanced security checks

Currently only ip change and useragent change are detected

Todo: Add challenge cookies - Create a cookie which changes every time and contains some challenge key which the server can verify with a session var cookie might need to be crypted (user pass)
Access: public

Parameters:

bool $flag — Enable or disable

[ Top ]

setAllowLogin [line 593]

void setAllowLogin(
[bool
$allowLogin = true])

Should the login form be displayed if neccessary?

Access: public

Parameters:

bool $allowLogin — show login form or not

[ Top ]

setAuth [line 708]

void setAuth(
string
$username)

Access: public

Parameters:

string $username — Username

[ Top ]

setAuthData [line 662]

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

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

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

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

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

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

void setSessionName(
[string
$name = 'session'])

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. This will chnage the name of the session variable auth uses to store it's data in the session

Access: public

Parameters:

string $name — New name for the session

[ Top ]

setShowLogin [line 578]

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

void start(
)

Start new auth session

Access: public

[ Top ]

staticCheckAuth [line 865]

boolean staticCheckAuth(
[
$options = null])

Statically checks if there is a session with valid auth information.

Return: Whether or not the user is authenticated.
See: Auth::checkAuth()
Access: public

Parameters:

$options —

[ Top ]

Class: Auth

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$advancedsecurity = false

$allowLogin = true

$authChecks = 0

$authdata =

$cookie =

$expire = 0

$expired = false

$idle = 0

$idled = false

$loginCallback = ''

$loginFailedCallback = ''

$loginFunction = ''

$logoutCallback = ''

$password = ''

$post =

$server =

$session =

$showLogin = true

$status = ''

$storage = ''

$username = ''

$version = "@version@"

Method Detail

Auth (Constructor) [line 270]

Parameters:

addUser [line 1035]

Parameters:

changePassword [line 1070]

Parameters:

checkAuth [line 773]

getAuth [line 883]

getAuthData [line 683]

Parameters:

getPostPasswordField [line 981]

getPostUsernameField [line 967]

getStatus [line 953]

getUsername [line 936]

listUsers [line 1016]

logout [line 901]

removeUser [line 1052]

Parameters:

sessionValidThru [line 995]

setAdvancedSecurity [line 759]

Parameters:

setAllowLogin [line 593]

Parameters:

setAuth [line 708]

Parameters:

setAuthData [line 662]

Parameters:

setExpire [line 525]

Parameters:

setFailedLoginCallback [line 626]

Parameters:

setIdle [line 541]

Parameters:

setLoginCallback [line 610]

Parameters:

setLogoutCallback [line 643]

Parameters:

setSessionName [line 562]

Parameters:

setShowLogin [line 578]

Parameters:

start [line 443]

staticCheckAuth [line 865]

Parameters: