Class ilSamlMappedUserAttributeValueParser. More...

Collaboration diagram for ilSamlMappedUserAttributeValueParser:

Public Member Functions
	__construct (\ilExternalAuthUserAttributeMappingRule $rule, array $userData)
	ilSamlMappedUserAttributeValueParser constructor. More...

	getAttributeKey ()

	parse ()

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

Protected Member Functions
	getValueIndex ()

Protected Attributes
	$rule

	$userData = []

Detailed Description

Class ilSamlMappedUserAttributeValueParser.

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

Constructor & Destructor Documentation

◆ __construct()

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

ilSamlMappedUserAttributeValueParser constructor.

Parameters

ilExternalAuthUserAttributeMappingRule	$rule
array	$userData

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

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

References $rule, and $userData.

Member Function Documentation

◆ getAttributeKey()

ilSamlMappedUserAttributeValueParser::getAttributeKey ( )

Returns: string

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

                                      : 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;
    }

Referenced by parse().

Here is the caller graph for this function:

◆ getValueIndex()

ilSamlMappedUserAttributeValueParser::getValueIndex ( )

protected

Returns: int

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

                                       : 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 $index >= 0 ? $index : 0;
    }

References $index.

Referenced by parse().

Here is the caller graph for this function:

◆ parse()

ilSamlMappedUserAttributeValueParser::parse ( )

Exceptions

ilSamlException

Returns: string

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

                            : 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;
    }