Mult-Rater Feedback
[ class tree: ALP ] [ index: ALP ] [ all elements ]

Class: ALP

Source Location: /shared/libs/unmauth.lib.php

Class Overview


ALP Class


Variables

Methods



Class Details

[line 55]
ALP Class

The Authentication Layer Package (ALP) class is coded specifically for UNM's implementation of phpCAS. This file should never be viewed by non-UNM developers, and the documentation for this should also be reserved for UNM developers only.

A separate file will be created for public use after this file is completed, and it will use similar documentation to show the layout of the class, and will serve as a template to make developing an Authentication Layer that works with packages from the HRIT_APPS category much easier.




[ Top ]


Class Variables

$isAuthenticated =  false

[line 70]

Public Authentication Flag



Tags:

var:  denotes whether or not the user is Authenticated
access:  public

Type:   boolean


[ Top ]

$netid =

[line 63]

Public netid string



Tags:

var:  contains username
access:  public

Type:   string


[ Top ]



Class Methods


constructor ALP [line 87]

void ALP( )

ALP Constructor Class

The Constructor Class will set up default variables And do anything neccessary to connect to an Authentication Server. Future calls to the ALP object should only be to:

  • Authenticate a User
  • Check if a User is Authenticated
  • Retrieve Username
  • Retrieve User Level




[ Top ]

method authenticateUser [line 139]

true|false authenticateUser( string $username, string $password)

Authentiate a User based on Username and Password

For heightened security, UNM does not pass username and password except for on secure CIRT servers, so we will not be using this.




Tags:

access:  public


Parameters:

string   $username   User's Clear-Text Username
string   $password   User's Clear-Text Password

[ Top ]

method checkUserAuthentication [line 180]

true|false checkUserAuthentication( )

Check User Authentication

Check to see if the user has already been authenticated.




Tags:

access:  public


[ Top ]

method forceUserAuthentication [line 161]

void|true forceUserAuthentication( )

Force User Authentication

This method forces there to be a logged in user, and does not require a specific username to be passed. This is used for authentication methods that redirect a user to a secure in-house authentication server.

This is the method UNM will use to be sure a user is logged in.

Calling this Method will take the user away from the page if they are not logged in, and will force them to log in via the standard UNM authentication server. If they are logged in, nothing will happen and the method will return true.




Tags:

access:  public


[ Top ]

method getUsername [line 111]

string|false getUsername( )

Get the current username

This method grabs the username from whatever authentication package your are using. In our case, this will be pulling it from phpCAS.




Tags:

return:  String username or false
access:  public


[ Top ]

method logUserOut [line 197]

true|false logUserOut( )

Log User Out of the MRF

Un-Authenticate the user, and get ready for the next individual to use the PC for MRF usage.




Tags:

access:  public


[ Top ]


Documentation generated on Fri, 27 Jan 2006 16:25:37 -0700 by phpDocumentor 1.3.0RC3