SAML_Auth_Manager Class Reference

Inheritance diagram for SAML_Auth_Manager:

Public Member Functions
	__construct ($authSource)
	login (array $params=array())
	logout ($params=NULL)
	printSPMetadataXML ($acs_url, $sls_url)

Protected Attributes
	$authSource

Detailed Description

Definition at line 31 of file saml_auth_manager.inc.

Constructor & Destructor Documentation

__construct

(

$authSource

)

Create an instance with the specified authsource.

Parameters

string

$authSource

The id of the authentication source.

Definition at line 48 of file saml_auth_manager.inc.

Member Function Documentation

login

(

array

$params = array()

)

Start an authentication process.

This function never returns.

This function accepts an array $params, which controls some parts of the authentication. The accepted parameters depends on the authentication source being used. Some parameters are generic:

• 'ErrorURL': An URL that should receive errors from the authentication.
• 'KeepPost': If the current request is a POST request, keep the POST data until after the authentication.
• 'ReturnTo': The URL the user should be returned to after authentication.
• 'ReturnCallback': The function we should call after the user has finished authentication.

Parameters

array

$params

various login options

Returns

null public

Definition at line 73 of file saml_auth_manager.inc.

logout

(

$params = NULL

)

Log the user out.

This function logs the user out. It will never return. By default, it will cause a redirect to the current page after logging the user out, but a different URL can be given with the $params parameter.

Generic parameters are:

• 'ReturnTo': The URL the user should be returned to after logout.
• 'ReturnCallback': The function that should be called after logout.
• 'ReturnStateParam': The parameter we should return the state in when redirecting.
• 'ReturnStateStage': The stage the state array should be saved with.

Parameters

array

$params

Either the url the user should be redirected to after logging out,

Returns

null public

Definition at line 170 of file saml_auth_manager.inc.

printSPMetadataXML	(		$acs_url,
			$sls_url
	)

Generate SP Metadata in XML format

Parameters

string	$acs_url	ACS url
string	$sls_url	SLS url

Returns

string public

Definition at line 230 of file saml_auth_manager.inc.

---

The documentation for this class was generated from the following file:

• /Users/webmaster/Desktop/squiz_matrix/packages/saml/lib/saml_auth_manager.inc