sspmod_core_Auth_Process_AttributeCopy Class Reference

Inheritance diagram for sspmod_core_Auth_Process_AttributeCopy:

Collaboration diagram for sspmod_core_Auth_Process_AttributeCopy:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...
	process (&$request)
	Apply filter to rename 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
	$map = array()
	Assosiative array with the mappings of attribute names. More...

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

Detailed Description

Definition at line 18 of file AttributeCopy.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_AttributeCopy::__construct	(		$config,
			$reserved
	)

Initialize this filter, parse configuration.

Parameters

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

Definition at line 32 of file AttributeCopy.php.

                                                        {
                parent::__construct($config, $reserved);
 
                assert('is_array($config)');
 
                foreach($config as $source => $destination) {
 
                        if(!is_string($source)) {
                                throw new Exception('Invalid source attribute name: ' . var_export($source, TRUE));
                        }
 
                        if(!is_string($destination) && !is_array($destination)) {
                                throw new Exception('Invalid destination attribute name: ' . var_export($destination, TRUE));
                        }
 
                        $this->map[$source] = $destination;
                }
        }

References $config, $destination, and $source.

Member Function Documentation

process()

sspmod_core_Auth_Process_AttributeCopy::process

(

&

$request

)

Apply filter to rename attributes.

Parameters

array

&$request

The current request

Reimplemented from SimpleSAML_Auth_ProcessingFilter.

Definition at line 57 of file AttributeCopy.php.

                                           {
                assert('is_array($request)');
                assert('array_key_exists("Attributes", $request)');
 
                $attributes =& $request['Attributes'];
 
                foreach($attributes as $name => $values) {
                        if (array_key_exists($name,$this->map)){
                                if (!is_array($this->map[$name])) {
                                        $attributes[$this->map[$name]] = $values;
                                } else {
                                        foreach ($this->map[$name] as $to_map) {
                                                $attributes[$to_map] = $values;
                                        }
                                }
                        }
                }
 
        }

References $attributes, and $name.

Field Documentation

$map

sspmod_core_Auth_Process_AttributeCopy::$map = array()

private

Assosiative array with the mappings of attribute names.

Definition at line 23 of file AttributeCopy.php.

---

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

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