SimpleSAML\Utils\Attributes Class Reference

Collaboration diagram for SimpleSAML\Utils\Attributes:

Static Public Member Functions
static	getExpectedAttribute ($attributes, $expected, $allow_multiple=false)
	Look for an attribute in a normalized attributes array, failing if it's not there. More...
static	normalizeAttributesArray ($attributes)
	Validate and normalize an array with attributes. More...
static	getAttributeNamespace ($name, $defaultns)
	Extract an attribute's namespace, or revert to default. More...

Detailed Description

Definition at line 10 of file Attributes.php.

Member Function Documentation

getAttributeNamespace()

static SimpleSAML\Utils\Attributes::getAttributeNamespace (   $name,   $defaultns  )

static

Extract an attribute's namespace, or revert to default.

This function takes in a namespaced attribute name and splits it in a namespace/attribute name tuple. When no namespace is found in the attribute name, it will be namespaced with the default namespace. This default namespace can be overriden by supplying a second parameter to this function.

Parameters

string	$name	The namespaced attribute name.
string	$defaultns	The default namespace that should be used when no namespace is found.

Returns

array The attribute name, split to the namespace and the actual attribute name.

Definition at line 123 of file Attributes.php.

References $name, and array.

Referenced by sspmod_adfs_IdP_ADFS\generateResponse().

    {
        $slash = strrpos($name, '/');
        if ($slash !== false) {
            $defaultns = substr($name, 0, $slash);
            $name = substr($name, $slash + 1);
        }
        return array(htmlspecialchars($defaultns), htmlspecialchars($name));
    }

Here is the caller graph for this function:

getExpectedAttribute()

static SimpleSAML\Utils\Attributes::getExpectedAttribute (   $attributes,   $expected,   $allow_multiple = false  )

static

Look for an attribute in a normalized attributes array, failing if it's not there.

Parameters

array	$attributes	The normalized array containing attributes.
string	$expected	The name of the attribute we are looking for.
bool	$allow_multiple	Whether to allow multiple values in the attribute or not.

Returns

mixed The value of the attribute we are expecting. If the attribute has multiple values and $allow_multiple is set to true, the first value will be returned.

Exceptions

Definition at line 26 of file Attributes.php.

References $attributes.

    {
        if (!is_array($attributes)) {
            throw new \InvalidArgumentException(
                'The attributes array is not an array, it is: '.print_r($attributes, true).'.'
            );
        }

        if (!is_string($expected)) {
            throw new \InvalidArgumentException(
                'The expected attribute is not a string, it is: '.print_r($expected, true).'.'
            );
        }

        if (!array_key_exists($expected, $attributes)) {
            throw new \SimpleSAML_Error_Exception("No such attribute '".$expected."' found.");
        }
        $attribute = $attributes[$expected];

        if (!is_array($attribute)) {
            throw new \InvalidArgumentException('The attributes array is not normalized, values should be arrays.');
        }

        if (count($attribute) === 0) {
            throw new \SimpleSAML_Error_Exception("Empty attribute '".$expected."'.'");

        } elseif (count($attribute) > 1) {
            if ($allow_multiple === false) {
                throw new \SimpleSAML_Error_Exception(
                    'More than one value found for the attribute, multiple values not allowed.'
                );
            }
        }
        return reset($attribute);
    }

normalizeAttributesArray()

static SimpleSAML\Utils\Attributes::normalizeAttributesArray (   $attributes )

static

Validate and normalize an array with attributes.

This function takes in an associative array with attributes, and parses and validates this array. On success, it will return a normalized array, where each attribute name is an index to an array of one or more strings. On failure an exception will be thrown. This exception will contain an message describing what is wrong.

Parameters

array

$attributes

The array containing attributes that we should validate and normalize.

Returns

array The normalized attributes array.

Exceptions

Definition at line 80 of file Attributes.php.

References $attributes, $name, array, and SimpleSAML\Utils\Arrays\arrayize().

Referenced by sspmod_exampleauth_Auth_Source_Static\__construct(), sspmod_exampleauth_Auth_Source_UserPass\__construct(), sspmod_authcrypt_Auth_Source_Hash\__construct(), sspmod_authcrypt_Auth_Source_Htpasswd\__construct(), and SimpleSAML_Utilities\parseAttributes().

    {
        if (!is_array($attributes)) {
            throw new \InvalidArgumentException(
                'The attributes array is not an array, it is: '.print_r($attributes, true).'".'
            );
        }

        $newAttrs = array();
        foreach ($attributes as $name => $values) {
            if (!is_string($name)) {
                throw new \InvalidArgumentException('Invalid attribute name: "'.print_r($name, true).'".');
            }

            $values = Arrays::arrayize($values);

            foreach ($values as $value) {
                if (!is_string($value)) {
                    throw new \InvalidArgumentException(
                        'Invalid attribute value for attribute '.$name.': "'.print_r($value, true).'".'
                    );
                }
            }

            $newAttrs[$name] = $values;
        }

        return $newAttrs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Utils/Attributes.php