Docs For Class NamePassTokenCollector

Description

The NamePassTokenCollector returns its tokens as an array with two elements: 'username', 'password'. Descendents of this abstract class must implement the collectName() and collectPassword() methods in addition to prompt inherited from TokenCollector.

version: $Id: NamePassTokenCollector.abstract.php,v 1.1 2005/03/16 22:48:41 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/authentication/NamePassTokenCollector.abstract.php (line 26)

TokenCollector
   |
   --NamePassTokenCollector

Direct descendents

Class	Description
BasicFormNamePassTokenCollector	The HTTPAuthNamePassTokenCollector prompts a user for their name and password by sending HTTP Authenticatio headers to the user.
HTTPAuthNamePassTokenCollector	The HTTPAuthNamePassTokenCollector prompts a user for their name and password by sending HTTP Authenticatio headers to the user.

Method Summary

mixed collect ()

mixed collectName ()

mixed collectPassword ()

Methods

collect (line 38)

Collect any tokens that the user may have supplied. Reply NULL if none are found. (This method uses the "Template Method" design pattern.)

since: 3/16/05
access: protected

mixed collect ()

Redefinition of:

TokenCollector::collect(): Collect any tokens that the user may have supplied. Reply NULL if none are found.

collectName (line 58)

Collect the name that the user may have supplied, Reply NULL if none are found.

since: 3/16/05
access: public

mixed collectName ()

Redefined in descendants as:

BasicFormNamePassTokenCollector::collectName() : Collect the name that the user may have supplied, Reply NULL if none are found.
HTTPAuthNamePassTokenCollector::collectName() : Collect the name that the user may have supplied, Reply NULL if none are found.

collectPassword (line 70)

Collect the password that the user may have supplied, Reply NULL if none are found.

since: 3/16/05
access: public

mixed collectPassword ()

Redefined in descendants as:

BasicFormNamePassTokenCollector::collectPassword() : Collect the password that the user may have supplied, Reply NULL if none are found.
HTTPAuthNamePassTokenCollector::collectPassword() : Collect the password that the user may have supplied, Reply NULL if none are found.

Inherited Methods

Inherited From TokenCollector

TokenCollector::collect()
TokenCollector::collectTokens()
TokenCollector::prompt()