Class: HttpAuthInterface_1_0

Source Location: /modules/httpauth/classes/HttpAuthInterface_1_0.class

Class HttpAuthInterface_1_0

Class Overview

This is an interface for the httpauth module. Modules that wish to opt-in for HTTPauth can utilize an implementation of this interface.

Located in /modules/httpauth/classes/HttpAuthInterface_1_0.class [line 43]

Author(s):

API Tags:

Abstract:
See:	ServerAuthPlugin
See:	HttpAuthPlugin

Methods

[ Top ]

Method Summary

array	getConfiguration()	Checks if HTTP authentication is enabled.
GalleryStatus	requestAuthentication()	Prompt the user via HTTP authentication for username / password.
GalleryStatus	setConfiguration()	Registers the HTTP authentication Gallery authentication plugin.

[ Top ]

Methods

getConfiguration [line 53]

array getConfiguration(
)

Checks if HTTP authentication is enabled.

API Tags:

Return:

GalleryStatus a status code, bool true if HTTPAuth is enabled, bool true if ServerAuth is enabled bool true if it is enabled globally or false if it is only enabled for specific modules

[ Top ]

requestAuthentication [line 74]

GalleryStatus requestAuthentication(
)

Prompt the user via HTTP authentication for username / password.

API Tags:

Return:

a status code

[ Top ]

setConfiguration [line 66]

GalleryStatus setConfiguration(
bool
$enableHttpAuth, [bool
$enableServerAuth = false], [bool
$useGlobally = false] 
)

Registers the HTTP authentication Gallery authentication plugin.

Parameters:

bool	$enableHttpAuth:	Set to true to activate HTTP auth, false to deactivate.
bool	$enableServerAuth:	(optional) Set to true to activate Server auth, false to deactivate (defaults to false).
bool	$useGlobally:	(optional) Set to true to activate auth for all modules, false to require modules to opt-in for HTTP auth (default),

API Tags:

Return:

a status code

[ Top ]

Documentation generated on Fri, 03 Oct 2008 05:17:05 -0700 by phpDocumentor 1.3.0RC6

	HttpAuth Classes

[ class tree: HttpAuth ] [ index: HttpAuth ] [ all elements ]