Docs For Class Guard

Description

**************************************************************

This file is part of the Core module of CompInaBox * Copyright 2002. Eric D. Nielsen, All rights reserverd * CompInaBox is availible for license under the GPL, see * the COPYING file in the root directory of the install for * the full terms of the GPL. * * File: Guard.inc * Author: Eric D. Nielsen * Description: Access control class, interacts with both User * and Gate to control access, at present Guard is * a simple class, but if distributed servers ever * occur it will be crucial to negotiating passage * Notes: This class, while currently static, is expected to * require instantiation in the future. For upward * compatibility, always instantiate a Guard. * *************************************************************

Located in /include/classes/access-control/Guard.inc (line 20)

Method Summary

Guard Guard ()

void examineCredentials (mixed $credentials)

void recognizesUser (mixed $username)

void referToScribe ()

void unlockGateWithKeys (mixed $gate, mixed $keys, mixed $failurePage)

Methods

Constructor Guard (line 28)

***********************************************************

Function: Guard * Description: The Guard constructor does nothing * Modifies: this * **********************************************************

Guard Guard ()

examineCredentials (line 50)

***********************************************************

Function: examineCredentials * Description: used to accept a user from another server, * Arguements: the current user's credentials * Returns: TRUE if this user has valid credintials * **********************************************************

void examineCredentials (mixed $credentials)

recognizesUser (line 38)

***********************************************************

Function: recognizesUser * Description: is this a local, authenticated user * Arguements: the current userid * Returns: TRUE if the userid is numeric and not zero * **********************************************************

void recognizesUser (mixed $username)

referToScribe (line 81)

***********************************************************

Function: referToScribe * Description: redirects the user to a login/create account * screen, returns to this page after login * **********************************************************

void referToScribe ()

unlockGateWithKeys (line 65)

***********************************************************

Function: unlockGateWithKeys * Description: Tries the user's keys in the gate * Arguments: gate -- the gate to attempt to unlock * keys -- the user's keys * Notes: Eventually this may include some intrustion * detection code and the ability to exile/execute * users caught acting in bad faith * If this function returns, the user may pass * **********************************************************

void unlockGateWithKeys (mixed $gate, mixed $keys, mixed $failurePage)