PEAR Manual
PrevNext

LiveUser::init()

LiveUser::init() -- Tries to retrieve auth object from session.

Synopsis

require_once 'LiveUser.php';

boolean LiveUser::init ([string $handle = '' [, string $passwd = '' [, boolean $logout = FALSE]]])

Description

If this fails, the class attempts a login based on cookie or form information (depends on class settings). Returns true if a auth object was successfully retrieved or created. Otherwise, false is returned.

Parameter

string $handle

handle of the user trying to authenticate

string $passwd

password of the user trying to authenticate

boolean $logout

set to TRUE if user wants to logout

Return value

returns true if init process well, false otherwise

Throws

throws no exceptions thrown

Note

This function can not be called statically.

PrevHomeNext
LiveUser::getStatus()UpLiveUser::isError()