sspmod_core_Auth_Process_AttributeRealm Class Reference

Inheritance diagram for sspmod_core_Auth_Process_AttributeRealm:

Collaboration diagram for sspmod_core_Auth_Process_AttributeRealm:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter. More...
	process (&$request)
	Apply filter to add or replace attributes. More...
Public Member Functions inherited from SimpleSAML_Auth_ProcessingFilter
	__construct (&$config, $reserved)
	Constructor for a processing filter. More...
	process (&$request)
	Process a request. More...

Private Attributes
	$attributename = 'realm'

Additional Inherited Members
Data Fields inherited from SimpleSAML_Auth_ProcessingFilter
	$priority = 50
	Priority of this filter. More...

Detailed Description

Definition at line 11 of file AttributeRealm.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_AttributeRealm::__construct	(		$config,
			$reserved
	)

Initialize this filter.

Parameters

array	$config	Configuration information about this filter.
mixed	$reserved	For future use.

Definition at line 21 of file AttributeRealm.php.

                                                    {
        parent::__construct($config, $reserved);
        assert('is_array($config)');
 
        if (array_key_exists('attributename', $config))
            $this->attributename = $config['attributename'];
 
    }

References $config.

Member Function Documentation

process()

sspmod_core_Auth_Process_AttributeRealm::process

(

&

$request

)

Apply filter to add or replace attributes.

Add or replace existing attributes with the configured values.

Parameters

array

&$request

The current request

Reimplemented from SimpleSAML_Auth_ProcessingFilter.

Definition at line 37 of file AttributeRealm.php.

                                       {
        assert('is_array($request)');
        assert('array_key_exists("Attributes", $request)');
 
        $attributes =& $request['Attributes'];
 
        if (!array_key_exists('UserID', $request)) {
            throw new Exception('core:AttributeRealm: Missing UserID for this user. Please' .
                ' check the \'userid.attribute\' option in the metadata against the' .
                ' attributes provided by the authentication source.');
        }
        $userID = $request['UserID'];
        $decomposed = explode('@', $userID);
        if (count($decomposed) !== 2) return;
        $request['Attributes'][$this->attributename] = array($decomposed[1]);
    }

References $attributename, and $attributes.

Field Documentation

$attributename

sspmod_core_Auth_Process_AttributeRealm::$attributename = 'realm'

private

Definition at line 13 of file AttributeRealm.php.

Referenced by process().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/core/lib/Auth/Process/AttributeRealm.php