sspmod_core_Auth_Process_ScopeAttribute Class Reference

Inheritance diagram for sspmod_core_Auth_Process_ScopeAttribute:

Collaboration diagram for sspmod_core_Auth_Process_ScopeAttribute:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...
	process (&$request)
	Apply this filter to the request. 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
	$scopeAttribute
	$sourceAttribute
	$targetAttribute
	$onlyIfEmpty = false

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

Detailed Description

Definition at line 8 of file ScopeAttribute.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_ScopeAttribute::__construct	(		$config,
			$reserved
	)

Initialize this filter, parse configuration.

Parameters

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

Definition at line 47 of file ScopeAttribute.php.

    {
                parent::__construct($config, $reserved);
                assert(is_array($config));
 
                $config = SimpleSAML_Configuration::loadFromArray($config, 'ScopeAttribute');
 
                $this->scopeAttribute = $config->getString('scopeAttribute');
                $this->sourceAttribute = $config->getString('sourceAttribute');
                $this->targetAttribute = $config->getString('targetAttribute');
                $this->onlyIfEmpty = $config->getBoolean('onlyIfEmpty', false);
        }

References $config, and SimpleSAML_Configuration\loadFromArray().

Here is the call graph for this function:

Member Function Documentation

process()

sspmod_core_Auth_Process_ScopeAttribute::process

(

&

$request

)

Apply this filter to the request.

Parameters

array

&$request

The current request

Reimplemented from SimpleSAML_Auth_ProcessingFilter.

Definition at line 66 of file ScopeAttribute.php.

    {
                assert(is_array($request));
                assert(array_key_exists('Attributes', $request));
 
                $attributes =& $request['Attributes'];
 
                if (!isset($attributes[$this->scopeAttribute])) {
                        return;
                }
 
                if (!isset($attributes[$this->sourceAttribute])) {
                        return;
                }
 
                if (!isset($attributes[$this->targetAttribute])) {
                        $attributes[$this->targetAttribute] = array();
                }
 
                if ($this->onlyIfEmpty && count($attributes[$this->targetAttribute]) > 0) {
                        return;
                }
 
                foreach ($attributes[$this->scopeAttribute] as $scope) {
                        if (strpos($scope, '@') !== false) {
                                $scope = explode('@', $scope, 2);
                                $scope = $scope[1];
                        }
 
                        foreach ($attributes[$this->sourceAttribute] as $value) {
                                $value = $value . '@' . $scope;
 
                                if (in_array($value, $attributes[$this->targetAttribute], true)) {
                                        // Already present
                                        continue;
                                }
 
                                $attributes[$this->targetAttribute][] = $value;
                        }
                }
        }

References $attributes, $request, and $targetAttribute.

Field Documentation

$onlyIfEmpty

sspmod_core_Auth_Process_ScopeAttribute::$onlyIfEmpty = false

private

Definition at line 38 of file ScopeAttribute.php.

$scopeAttribute

sspmod_core_Auth_Process_ScopeAttribute::$scopeAttribute

private

Definition at line 15 of file ScopeAttribute.php.

$sourceAttribute

sspmod_core_Auth_Process_ScopeAttribute::$sourceAttribute

private

Definition at line 23 of file ScopeAttribute.php.

$targetAttribute

sspmod_core_Auth_Process_ScopeAttribute::$targetAttribute

private

Definition at line 31 of file ScopeAttribute.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/ScopeAttribute.php