DiogenesCoreSession Class Reference

Inheritance diagram for DiogenesCoreSession:

[legend]List of all members.

Public Member Functions
	DiogenesCoreSession ()
	hasPerms ($level)
	doAuth (&$page)
	doLogin (&$page)
	getUserId ($auth, $username)
	getUsername ($auth, $uid)
	lookupUserId ($auth, $username)
	lookupUsername ($auth, $uid)
Public Attributes
	$challenge
	$uid
	$username
	$perms

---

Detailed Description

This class describes a Diogenes session.

Definition at line 29 of file diogenes.core.session.inc.php.

---

Member Function Documentation

DiogenesCoreSession::DiogenesCoreSession

(

)

The constructor.

Definition at line 42 of file diogenes.core.session.inc.php.

Referenced by DiogenesSession::DiogenesSession().

DiogenesCoreSession::hasPerms

(

$

level

)

Does the user have a given permission level.

Parameters:

level

Definition at line 53 of file diogenes.core.session.inc.php.

DiogenesCoreSession::doAuth

(

&$

page

)

Perform authentication. This needs to be overriden to do anything useful.

Parameters:

page

the calling page (by reference)

Reimplemented in DiogenesSession.

Definition at line 64 of file diogenes.core.session.inc.php.

References doLogin().

Here is the call graph for this function:

DiogenesCoreSession::doLogin

(

&$

page

)

Display login screen. Needs to be overriden!

Parameters:

page

the page asking for authentication

Reimplemented in DiogenesSession.

Definition at line 86 of file diogenes.core.session.inc.php.

Referenced by doAuth().

DiogenesCoreSession::getUserId	(	$	auth,
		$	username
	)

Returns the user id associated with a given username. We use caching to avoid unnecessary database requests.

Actual lookup is performed by the lookupUserId function.

Parameters:

	$auth	the authentication method
	$username	the username to look up

See also:

DiogenesLoggerView

lookupUserId

Definition at line 103 of file diogenes.core.session.inc.php.

References $uid, $username, and lookupUserId().

Here is the call graph for this function:

DiogenesCoreSession::getUsername	(	$	auth,
		$	uid
	)

Returns the username associated with a given user id. We use caching to avoid unnecessary database requests.

Actual lookup is performed by the lookupUsername function.

Parameters:

	$auth	the authentication method
	$uid	the username to look up

See also:

DiogenesLoggerView

lookupUsername

Definition at line 136 of file diogenes.core.session.inc.php.

References $uid, $username, and lookupUsername().

Here is the call graph for this function:

DiogenesCoreSession::lookupUserId	(	$	auth,
		$	username
	)

Look up the user id associated with a given username.

Parameters:

	$auth	the authentication method
	$username	the username to look up

See also:

DiogenesLoggerView

Definition at line 165 of file diogenes.core.session.inc.php.

References $uid.

Referenced by getUserId().

DiogenesCoreSession::lookupUsername	(	$	auth,
		$	uid
	)

Looks up the username associated with a given user id.

Parameters:

	$auth	the authentication method
	$uid	the username to look up

See also:

DiogenesLoggerView

Definition at line 184 of file diogenes.core.session.inc.php.

References $username.

Referenced by getUsername().

---

Member Data Documentation

DiogenesCoreSession::$challenge

authentication challenge

Definition at line 31 of file diogenes.core.session.inc.php.

DiogenesCoreSession::$uid

unique user id

Definition at line 34 of file diogenes.core.session.inc.php.

Referenced by DiogenesSession::doAuth(), DiogenesSession::doAuthWebDAV(), getUserId(), getUsername(), and lookupUserId().

DiogenesCoreSession::$username

username (login)

Definition at line 36 of file diogenes.core.session.inc.php.

Referenced by DiogenesSession::doAuth(), getUserId(), getUsername(), and lookupUsername().

DiogenesCoreSession::$perms

permissions

Definition at line 38 of file diogenes.core.session.inc.php.

Referenced by DiogenesSession::doAuth(), and DiogenesSession::doAuthWebDAV().

---

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

• diogenes.core.session.inc.php

---