ilSamlMappedUserAttributeValueParser Class Reference

Class ilSamlMappedUserAttributeValueParser. More...

Collaboration diagram for ilSamlMappedUserAttributeValueParser:

Public Member Functions
	__construct (ilExternalAuthUserAttributeMappingRule $rule, array $userData)
	getAttributeKey ()
	parse ()

Protected Member Functions
	getValueIndex ()

Protected Attributes
ilExternalAuthUserAttributeMappingRule	$rule
array	$userData = []

Private Attributes
const	ATTR_REGEX = '/^(.*?)(\|(\d+))?$/'

Detailed Description

Class ilSamlMappedUserAttributeValueParser.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilSamlMappedUserAttributeValueParser.php.

Constructor & Destructor Documentation

__construct()

ilSamlMappedUserAttributeValueParser::__construct	(	ilExternalAuthUserAttributeMappingRule	$rule,
		array	$userData
	)

Definition at line 33 of file class.ilSamlMappedUserAttributeValueParser.php.

References $rule, and $userData.

    {
        $this->rule = $rule;
        $this->userData = $userData;
    }

Member Function Documentation

getAttributeKey()

ilSamlMappedUserAttributeValueParser::getAttributeKey

(

)

Definition at line 53 of file class.ilSamlMappedUserAttributeValueParser.php.

Referenced by parse().

                                     : string
    {
        $attribute = '';

        $matches = [];
        preg_match(self::ATTR_REGEX, $this->rule->getExternalAttribute(), $matches);

        if (is_array($matches) && isset($matches[1]) && is_string($matches[1])) {
            $attribute = $matches[1];
        }

        return $attribute;
    }

Here is the caller graph for this function:

getValueIndex()

ilSamlMappedUserAttributeValueParser::getValueIndex ( )

protected

Definition at line 39 of file class.ilSamlMappedUserAttributeValueParser.php.

References $index, and ILIAS\Repository\int().

Referenced by parse().

                                      : int
    {
        $index = 0;

        $matches = [];
        preg_match(self::ATTR_REGEX, $this->rule->getExternalAttribute(), $matches);

        if (is_array($matches) && isset($matches[3]) && is_numeric($matches[3])) {
            $index = (int) $matches[3];
        }

        return max($index, 0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parse()

ilSamlMappedUserAttributeValueParser::parse

(

)

Definition at line 67 of file class.ilSamlMappedUserAttributeValueParser.php.

References getAttributeKey(), and getValueIndex().

                           : string
    {
        $attributeKey = $this->getAttributeKey();

        if (!array_key_exists($attributeKey, $this->userData)) {
            throw new ilSamlException(sprintf(
                "Configured external attribute of mapping '%s' -> '%s' does not exist in SAML attribute data.",
                $this->rule->getAttribute(),
                $this->rule->getExternalAttribute()
            ));
        }

        $value = $this->userData[$attributeKey];

        if (is_array($value)) {
            $valueIndex = $this->getValueIndex();

            if (!array_key_exists($valueIndex, $value)) {
                throw new ilSamlException(sprintf(
                    "Configured external attribute of mapping '%s' -> '%s' does not exist in SAML attribute data.",
                    $this->rule->getAttribute(),
                    $this->rule->getExternalAttribute()
                ));
            }

            $value = $value[$valueIndex];
        }

        if (!is_scalar($value)) {
            throw new ilSamlException(sprintf(
                "Could not parse a scalar value based on the user attribute mapping '%s' -> '%s'.",
                $this->rule->getAttribute(),
                $this->rule->getExternalAttribute()
            ));
        }

        return (string) $value;
    }

Here is the call graph for this function:

Field Documentation

$rule

ilExternalAuthUserAttributeMappingRule ilSamlMappedUserAttributeValueParser::$rule

protected

Definition at line 29 of file class.ilSamlMappedUserAttributeValueParser.php.

Referenced by __construct().

$userData

array ilSamlMappedUserAttributeValueParser::$userData = []

protected

Definition at line 31 of file class.ilSamlMappedUserAttributeValueParser.php.

Referenced by __construct().

ATTR_REGEX

const ilSamlMappedUserAttributeValueParser::ATTR_REGEX = '/^(.*?)(\|(\d+))?$/'

private

Definition at line 27 of file class.ilSamlMappedUserAttributeValueParser.php.

---

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

• Services/Saml/classes/class.ilSamlMappedUserAttributeValueParser.php