Docs For Class TokenCollector

Class TokenCollector

Description

The TokenCollector is reponsible for prompting a user authentication tokens and recieving the response from the user.

version: $Id: TokenCollector.abstract.php,v 1.2 2005/03/23 21:26:40 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Direct descendents

Class	Description
NamePassTokenCollector	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.

Method Summary

mixed collect ()

mixed collectTokens ()

void prompt ()

Methods

collect (line 60)

Collect any tokens that the user may have supplied. Reply NULL if none are found.

mixed collect ()

Redefined in descendants as:

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

collectTokens (line 32)

Run the token collection sequence involving prompting for and collecting tokens.

mixed collectTokens ()

Redefined in descendants as:

HTTPAuthNamePassTokenCollector::collectTokens() : Run the token collection sequence involving prompting for and collecting tokens.

prompt (line 48)

Prompt the user to supply their tokens

void prompt ()

Redefined in descendants as:

BasicFormNamePassTokenCollector::prompt() : Prompt the user to supply their tokens
FormActionNamePassTokenCollector::prompt() : Prompt the user to supply their tokens
HTTPAuthNamePassTokenCollector::prompt() : Prompt the user to supply their tokens

Documentation generated on Wed, 19 Sep 2007 10:27:31 -0400 by phpDocumentor 1.3.0RC3