sspmod_core_Auth_Process_AttributeAdd Class Reference

Inheritance diagram for sspmod_core_Auth_Process_AttributeAdd:

Collaboration diagram for sspmod_core_Auth_Process_AttributeAdd:

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
	$replace = FALSE
	Flag which indicates wheter this filter should append new values or replace old values. More...
	$attributes = array()
	Attributes which should be added/appended. More...

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 AttributeAdd.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_AttributeAdd::__construct	(		$config,
			$reserved
	)

Initialize this filter.

Parameters

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

Definition at line 33 of file AttributeAdd.php.

                                                        {
                parent::__construct($config, $reserved);
 
                assert(is_array($config));
 
                foreach($config as $name => $values) {
                        if(is_int($name)) {
                                if($values === '%replace') {
                                        $this->replace = TRUE;
                                } else {
                                        throw new Exception('Unknown flag: ' . var_export($values, TRUE));
                                }
                                continue;
                        }
 
                        if(!is_array($values)) {
                                $values = array($values);
                        }
                        foreach($values as $value) {
                                if(!is_string($value)) {
                                        throw new Exception('Invalid value for attribute ' . $name . ': ' .
                                                var_export($values, TRUE));
                                }
                        }
 
                        $this->attributes[$name] = $values;
                }
        }

References $config, $name, and $values.

Member Function Documentation

process()

sspmod_core_Auth_Process_AttributeAdd::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 70 of file AttributeAdd.php.

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

References $attributes, $name, $request, and $values.

Field Documentation

$attributes

sspmod_core_Auth_Process_AttributeAdd::$attributes = array()

private

Attributes which should be added/appended.

Assiciative array of arrays.

Definition at line 24 of file AttributeAdd.php.

Referenced by process().

$replace

sspmod_core_Auth_Process_AttributeAdd::$replace = FALSE

private

Flag which indicates wheter this filter should append new values or replace old values.

Definition at line 16 of file AttributeAdd.php.

---

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

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