Auth::setCheckAuthCallback()
Prev		Next

Auth::setCheckAuthCallback()

Auth::setCheckAuthCallback() – set a callback to run when ever session validity is checked

Synopsis

void Auth::setCheckAuthCallback ( string $checkAuthCallback )

Description

This function sets a callback function which is called whenever the validity of a logged in session is checked. This callback can be used to perform actions like checking the authentication source to see if the logged in user is still enabled.

The callback function will be passed two parameters, the username that successfully logged in and a reference to the Auth object. The callback function should return a boolean depending upon whether the session should continue or not. TRUE to allow the session to continue, FALSE to abort the session.

If the session is aborted by this callback the status will be set to AUTH_CALLBACK_ABORT.

Parameter

string $checkAuthCallback: the call back function to use

Note

This function can not be called statically.

Prev	Auth	Next
Auth::setAuthData()	PEAR Manual	Auth::setExpire()