Docs For Class HttpAuthHelper

Method Summary

void	addHttpAuthToUrl()	Adds the given pair of username / password to the given URL as HTTP auth user:pass@hostname.
array	checkConfiguration()	Check this module's configuration.
array	checkHttpAuth()	Check that Gallery can access HTTP usernames and passwords.
void	getConfiguration()
array	getHttpAuth()	Get the HTTP authtype, username, and password using either the PHP server variables or the authorization request variable.
array	getUser()	Common code from HttpAuthPlugin::getUser and ServerAuthPlugin::getUser.
GalleryStatus	regenerateSessionIfNecessary()	Regenerate the session if this request might the initial login (active auth vs passive auth).
void	requestAuthentication()
void	setConfiguration()
void	stripHttpAuthFromUrl()	Removes user:pass from the given URL.
void	_buildUrl()	Build a URL from its components.

[ Top ]

Methods

addHttpAuthToUrl [line 258]

void addHttpAuthToUrl(
string
$url, string
$username, string
$password 
)

Adds the given pair of username / password to the given URL as HTTP auth user:pass@hostname.

Parameters:

string	$url:	An absolute URL
string	$username:
string	$password:

[ Top ]

checkConfiguration [line 49]

array checkConfiguration(
)

Check this module's configuration.

API Tags:

Return:

GalleryStatus a status code int HTTP auth status code

[ Top ]

checkHttpAuth [line 117]

array checkHttpAuth(
)

Check that Gallery can access HTTP usernames and passwords.

API Tags:

Return:

GalleryStatus a status code boolean true if Gallery can access HTTP usernames and passwords

[ Top ]

getConfiguration [line 279]

void getConfiguration(
)

API Tags:

See:

HttpAuthInterface_1_0::getConfiguration

[ Top ]

getHttpAuth [line 153]

array getHttpAuth(
)

Get the HTTP authtype, username, and password using either the PHP server variables or the authorization request variable.

API Tags:

Return:

string HTTP authtype string HTTP username string HTTP password

[ Top ]

getUser [line 187]

array getUser(
mixed
$authtype, mixed
$username 
)

Common code from HttpAuthPlugin::getUser and ServerAuthPlugin::getUser.

Potentially filters authentication type and username with regular expressions before returning active user.

API Tags:

Return:

GalleryStatus a status code GalleryUser the active user or null

[ Top ]

regenerateSessionIfNecessary [line 236]

GalleryStatus regenerateSessionIfNecessary(
GalleryUser
$authenticatedUser 
)

Regenerate the session if this request might the initial login (active auth vs passive auth).

Parameters:

GalleryUser

$authenticatedUser:

user authenticated for this request

API Tags:

Return:

a status code

[ Top ]

requestAuthentication [line 321]

void requestAuthentication(
[
$ignoreUseGloballyFlag = true] 
)

Parameters:

$ignoreUseGloballyFlag:

API Tags:

See:

HttpAuthInterface_1_0::requestAuthentication

[ Top ]

setConfiguration [line 291]

void setConfiguration(

$enableHttpAuth, [
$enableServerAuth = false], [
$useGlobally = false] 
)

Parameters:

	$enableHttpAuth:
	$enableServerAuth:
	$useGlobally:

API Tags:

See:

HttpAuthInterface_1_0::setConfiguration

[ Top ]

stripHttpAuthFromUrl [line 269]

void stripHttpAuthFromUrl(
string
$url 
)

Removes user:pass from the given URL.

Parameters:

string

$url:

An absolute URL

[ Top ]

_buildUrl [line 347]

void _buildUrl(
array
$components 
)

Build a URL from its components.

Parameters:

array

$components:

URL components in the format of parse_url

API Tags:

Access:

private

[ Top ]

	HttpAuth Classes

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

Class: HttpAuthHelper

Class HttpAuthHelper