ilAuthPDOInterface Interface Reference

Inheritance diagram for ilAuthPDOInterface:

Collaboration diagram for ilAuthPDOInterface:

Public Member Functions
	setIdle ($time, $add=false)
	Set maximum idle time. More...
	setExpire ($time, $add=false)
	Set the maximum expire time. More...
	start ()
	Start new auth session. More...
	getAuth ()
	Has the user been authenticated? More...
	getStatus ()
	getUsername ()
	sessionValidThru ()
	Returns the time up to the session is valid. More...
	logout ()

Detailed Description

Definition at line 3 of file interface.ilAuthPDOInterface.php.

Member Function Documentation

getAuth()

ilAuthPDOInterface::getAuth

(

)

Has the user been authenticated?

Is there a valid login session. Previously this was different from checkAuth() but now it is just an alias.

Returns

bool True if the user is logged in, otherwise false.

Implemented in ilPDOAuthentication.

getStatus()

ilAuthPDOInterface::getStatus

(

)

Returns

string

Implemented in ilPDOAuthentication.

getUsername()

ilAuthPDOInterface::getUsername

(

)

Returns

string

Implemented in ilPDOAuthentication.

logout()

ilAuthPDOInterface::logout

(

)

Returns

void

Implemented in ilPDOAuthentication.

sessionValidThru()

ilAuthPDOInterface::sessionValidThru

(

)

Returns the time up to the session is valid.

public

Returns

integer

Implemented in ilPDOAuthentication.

setExpire()

ilAuthPDOInterface::setExpire	(		$time,
			$add = false
	)

Set the maximum expire time.

Parameters

int	$time	Time in seconds
bool	$add	Add time to current expire time or not

Returns

void

Implemented in ilPDOAuthentication.

setIdle()

ilAuthPDOInterface::setIdle	(		$time,
			$add = false
	)

Set maximum idle time.

Parameters

int	$time	Time in seconds.
bool	$add	Add to current idle time?

Returns

void

Implemented in ilPDOAuthentication.

start()

ilAuthPDOInterface::start

(

)

Start new auth session.

Returns

void

Implemented in ilPDOAuthentication.

---

The documentation for this interface was generated from the following file:

• Services/Authentication/classes/PDO/interface.ilAuthPDOInterface.php