Docs For Class HTTPAuthNamePassTokenCollector

Description

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

version: $Id: HTTPAuthNamePassTokenCollector.class.php,v 1.3 2006/11/30 22:02:18 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/authentication/HTTPAuthNamePassTokenCollector.class.php (line 24)

TokenCollector
   |
   --NamePassTokenCollector
      |
      --HTTPAuthNamePassTokenCollector

Method Summary

<##> HTTPAuthNamePassTokenCollector ([<##> $relm = null], [mixed $cancelFunction = null])

mixed collectName ()

mixed collectPassword ()

mixed collectTokens (string $authTypeKey)

void printCancelMessage ()

void prompt ()

Methods

Constructor HTTPAuthNamePassTokenCollector (line 36)

Constructor, pass params

since: 8/7/06
access: public

<##> HTTPAuthNamePassTokenCollector ([<##> $relm = null], [mixed $cancelFunction = null])

<##> $relm

collectName (line 98)

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

since: 3/16/05
access: public

mixed collectName ()

Redefinition of:

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

collectPassword (line 110)

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

since: 3/16/05
access: public

mixed collectPassword ()

Redefinition of:

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

collectTokens (line 60)

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

since: 3/18/05
access: public

mixed collectTokens (string $authTypeKey)

string $authTypeKey: Allows the token colletor to know whether it has prompted for tokens for the particular auth type yet, allowing one prompting to return tokens for each authtype in an execution cycle.

Redefinition of:

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

printCancelMessage (line 122)

Print out a message if the user hits cancel in the HTTP authentication dialog.

since: 8/7/06
access: public

void printCancelMessage ()

prompt (line 83)

Prompt the user to supply their tokens

since: 3/16/05
access: public

void prompt ()

Redefinition of:

TokenCollector::prompt(): Prompt the user to supply their tokens

Inherited Methods

Inherited From NamePassTokenCollector

NamePassTokenCollector::collect()
NamePassTokenCollector::collectName()
NamePassTokenCollector::collectPassword()

Inherited From TokenCollector

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