sspmod_core_Auth_Process_AttributeAlter Class Reference

Inheritance diagram for sspmod_core_Auth_Process_AttributeAlter:

Collaboration diagram for sspmod_core_Auth_Process_AttributeAlter:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter. More...
	process (&$request)
	Apply the filter to modify 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
	Should the pattern found be replaced? More...
	$remove = FALSE
	Should the value found be removed? More...
	$pattern = ''
	Pattern to search for. More...
	$replacement = FALSE
	String to replace the pattern found with. More...
	$subject = ''
	Attribute to search in. More...
	$target = ''
	Attribute to place the result in. More...

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

Detailed Description

Definition at line 10 of file AttributeAlter.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_AttributeAlter::__construct	(		$config,
			$reserved
	)

Initialize this filter.

Parameters

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

Exceptions

SimpleSAML_Error_Exception

In case of invalid configuration.

Definition at line 49 of file AttributeAlter.php.

References $config, and $name.

                                                    {
        parent::__construct($config, $reserved);

        assert('is_array($config)');

        // parse filter configuration
        foreach ($config as $name => $value) {
            if (is_int($name)) {
                // check if this is an option
                if($value === '%replace') {
                    $this->replace = TRUE;
                } elseif ($value === '%remove') {
                    $this->remove = TRUE;
                } else {
                    throw new SimpleSAML_Error_Exception('Unknown flag : ' . var_export($value, TRUE));
                }
                continue;
            }

            // Set pattern
            if ($name === 'pattern') {
                $this->pattern = $value;
            }

            // Set replacement
            if ($name === 'replacement') {
                $this->replacement = $value;
            }

            // Set subject
            if ($name === 'subject') {
                $this->subject = $value;
            }

            // Set target
            if ($name === 'target') {
                $this->target = $value;
            }
        }
    }

Member Function Documentation

process()

sspmod_core_Auth_Process_AttributeAlter::process

(

&

$request

)

Apply the filter to modify attributes.

Modify existing attributes with the configured values.

Parameters

array

&$request

The current request.

Exceptions

SimpleSAML_Error_Exception

In case of invalid configuration.

Definition at line 98 of file AttributeAlter.php.

References $attributes, $replacement, $subject, $target, and array.

                                       {
        assert('is_array($request)');
        assert('array_key_exists("Attributes", $request)');

        // get attributes from request
        $attributes =& $request['Attributes'];

        // check that all required params are set in config
        if (empty($this->pattern) || empty($this->subject)) {
            throw new SimpleSAML_Error_Exception("Not all params set in config.");
        }

        if (!$this->replace && !$this->remove && $this->replacement === false) {
            throw new SimpleSAML_Error_Exception("'replacement' must be set if neither '%replace' nor ".
                "'%remove' are set.");
        }

        if (!$this->replace && $this->replacement === null) {
            throw new SimpleSAML_Error_Exception("'%replace' must be set if 'replacement' is null.");
        }

        if ($this->replace && $this->remove) {
            throw new SimpleSAML_Error_Exception("'%replace' and '%remove' cannot be used together.");
        }

        if (empty($this->target)) {
            // use subject as target if target is not set
            $this->target = $this->subject;
        }

        if ($this->subject !== $this->target && $this->remove) {
            throw new SimpleSAML_Error_Exception("Cannot use '%remove' when 'target' is different than 'subject'.");
        }

        if (!array_key_exists($this->subject, $attributes)) {
            // if no such subject, stop gracefully
            return;
        }

        if ($this->replace) { // replace the whole value
            foreach ($attributes[$this->subject] as &$value) {
                $matches = array();
                if (preg_match($this->pattern, $value, $matches) > 0) {
                    $new_value = $matches[0];

                    if ($this->replacement !== FALSE) {
                        $new_value = $this->replacement;
                    }

                    if ($this->subject === $this->target) {
                        $value = $new_value;
                    } else {
                        $attributes[$this->target] = array($new_value);
                    }
                }
            }
        } elseif ($this->remove) { // remove the whole value
            $removedAttrs = array();
            foreach ($attributes[$this->subject] as $value) {
                $matches = array();
                if (preg_match($this->pattern, $value, $matches) > 0) {
                    $removedAttrs[] = $value;
                }
            }
            $attributes[$this->target] = array_diff($attributes[$this->subject], $removedAttrs);

            if (empty($attributes[$this->target])) {
                unset($attributes[$this->target]);
            }
        } else { // replace only the part that matches
            if ($this->subject === $this->target) {
                $attributes[$this->target] = preg_replace($this->pattern, $this->replacement,
                                                          $attributes[$this->subject]);
            } else {
                $attributes[$this->target] = array_diff(preg_replace($this->pattern, $this->replacement,
                                                                     $attributes[$this->subject]),
                                                        $attributes[$this->subject]);
            }
        }
    }

Field Documentation

$pattern

sspmod_core_Auth_Process_AttributeAlter::$pattern = ''

private

Pattern to search for.

Definition at line 25 of file AttributeAlter.php.

$remove

sspmod_core_Auth_Process_AttributeAlter::$remove = FALSE

private

Should the value found be removed?

Definition at line 20 of file AttributeAlter.php.

$replace

sspmod_core_Auth_Process_AttributeAlter::$replace = FALSE

private

Should the pattern found be replaced?

Definition at line 15 of file AttributeAlter.php.

$replacement

sspmod_core_Auth_Process_AttributeAlter::$replacement = FALSE

private

String to replace the pattern found with.

Definition at line 30 of file AttributeAlter.php.

Referenced by process().

$subject

sspmod_core_Auth_Process_AttributeAlter::$subject = ''

private

Attribute to search in.

Definition at line 35 of file AttributeAlter.php.

Referenced by process().

$target

sspmod_core_Auth_Process_AttributeAlter::$target = ''

private

Attribute to place the result in.

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