Docs For Class TimeAuth

Class TimeAuth

Description

PEAR Auth customization

We subclass Auth for various reasons

It will be easier to use a single Auth instance using instance()

It will make a global $error string available

Auth
   |
   --TimeAuth

Method Summary

TimeAuth TimeAuth ([mixed $storageDriver = "DB"], [mixed $options = null], [mixed $loginFunction = ""], [mixed $showLogin = false])

void error_mapping (mixed $pear)

void instance ([mixed $storageDriver = "DB"], [mixed $options = ""], [mixed $loginFunction = ""], [mixed $showLogin = false])

void login_screen (mixed $username, [mixed $error = null])

void refuse_access (mixed $error)

void start ()

Methods

Constructor TimeAuth (line 51)

TimeAuth TimeAuth ([mixed $storageDriver = "DB"], [mixed $options = null], [mixed $loginFunction = ""], [mixed $showLogin = false])

error_mapping (line 119)

void error_mapping (mixed $pear)

instance (line 103)

return always the same instance of this class

useful to check the auth of a user over and over again without having to recreate the object and use the proper args

$storageDriver and $options are ignored and subsequent calls

void instance ([mixed $storageDriver = "DB"], [mixed $options = ""], [mixed $loginFunction = ""], [mixed $showLogin = false])

login_screen (line 160)

callback function for Auth in case of login failure

this function shouldn't return, otherwise login auth will not be enforced and a page will display even with an auth check

void login_screen (mixed $username, [mixed $error = null])

refuse_access (line 146)

function used to refuse access to a given section

this will output a page, with the error message, and exit()

argument will be printed in the output

void refuse_access (mixed $error)

start (line 88)

void start ()

Documentation generated on Tue, 11 Jan 2005 01:38:23 -0500 by phpDocumentor 1.3.0RC3