Inheritance diagram for sspmod_exampleauth_Auth_Source_Static:

Collaboration diagram for sspmod_exampleauth_Auth_Source_Static:

Public Member Functions
	__construct ($info, $config)
	Constructor for this authentication source. More...

	authenticate (&$state)
	Log in using static attributes. More...

Public Member Functions inherited from SimpleSAML_Auth_Source
	__construct ($info, &$config)
	Constructor for an authentication source. More...

	getAuthId ()
	Retrieve the ID of this authentication source. More...

	authenticate (&$state)
	Process a request. More...

	reauthenticate (array &$state)
	Reauthenticate an user. More...

	initLogin ($return, $errorURL=null, array $params=array())
	Start authentication. More...

	logout (&$state)
	Log out from this authentication source. More...

Private Attributes
	$attributes
	The attributes we return. More...

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML_Auth_Source
static	getSourcesOfType ($type)
	Get sources of a specific type. More...

static	completeAuth (&$state)
	Complete authentication. More...

static	loginCompleted ($state)
	Called when a login operation has finished. More...

static	completeLogout (&$state)
	Complete logout. More...

static	getById ($authId, $type=null)
	Retrieve authentication source. More...

static	logoutCallback ($state)
	Called when the authentication source receives an external logout request. More...

static	getSources ()
	Retrieve list of authentication sources. More...

Protected Member Functions inherited from SimpleSAML_Auth_Source
	addLogoutCallback ($assoc, $state)
	Add a logout callback association. More...

	callLogoutCallback ($assoc)
	Call a logout callback based on association. More...

Static Protected Member Functions inherited from SimpleSAML_Auth_Source
static	validateSource ($source, $id)
	Make sure that the first element of an auth source is its identifier. More...

Protected Attributes inherited from SimpleSAML_Auth_Source
	$authId

Detailed Description

Definition at line 12 of file Static.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_exampleauth_Auth_Source_Static::__construct	(	$info,
		$config
	)

Constructor for this authentication source.

Parameters

array	$info	Information about this authentication source.
array	$config	Configuration.

Definition at line 27 of file Static.php.

References $config, $info, and SimpleSAML\Utils\Attributes\normalizeAttributesArray().

                                                     {
                 assert(is_array($info));
                 assert(is_array($config));
 
                 // Call the parent constructor first, as required by the interface
                 parent::__construct($info, $config);
 
 
                 // Parse attributes
                 try {
                         $this->attributes = SimpleSAML\Utils\Attributes::normalizeAttributesArray($config);
                 } catch(Exception $e) {
                         throw new Exception('Invalid attributes for authentication source ' .
                                 $this->authId . ': ' . $e->getMessage());
                 }
 
         }

Here is the call graph for this function:

Member Function Documentation

◆ authenticate()

sspmod_exampleauth_Auth_Source_Static::authenticate ( & $state )

Log in using static attributes.

Parameters

array &$state Information about the current authentication.

Definition at line 51 of file Static.php.

References $attributes, and $state.

                                               {
                 assert(is_array($state));
 
                 $state['Attributes'] = $this->attributes;
         }

Field Documentation

◆ $attributes

sspmod_exampleauth_Auth_Source_Static::$attributes

private

The attributes we return.

Definition at line 18 of file Static.php.

Referenced by authenticate().

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/exampleauth/lib/Auth/Source/Static.php

Public Member Functions

Private Attributes