SAML2\XML\saml\Attribute Class Reference

Inheritance diagram for SAML2\XML\saml\Attribute:

Collaboration diagram for SAML2\XML\saml\Attribute:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Initialize an Attribute. More...
	toXML (\DOMElement $parent)
	Convert this Attribute to XML. More...

Data Fields
	$Name
	$NameFormat
	$FriendlyName = null
	$AttributeValue = array()

Protected Member Functions
	toXMLInternal (\DOMElement $parent, $namespace, $name)
	Internal implementation of toXML. More...

Detailed Description

Definition at line 13 of file Attribute.php.

Constructor & Destructor Documentation

__construct()

SAML2\XML\saml\Attribute::__construct

(

\DOMElement

$xml = null

)

Initialize an Attribute.

Parameters

\DOMElement | null

$xml

The XML element we should load.

Exceptions

Exception

Reimplemented in SAML2\XML\md\RequestedAttribute.

Definition at line 51 of file Attribute.php.

    {
        if ($xml === null) {
            return;
        }
 
        if (!$xml->hasAttribute('Name')) {
            throw new \Exception('Missing Name on Attribute.');
        }
        $this->Name = $xml->getAttribute('Name');
 
        if ($xml->hasAttribute('NameFormat')) {
            $this->NameFormat = $xml->getAttribute('NameFormat');
        }
 
        if ($xml->hasAttribute('FriendlyName')) {
            $this->FriendlyName = $xml->getAttribute('FriendlyName');
        }
 
        foreach (Utils::xpQuery($xml, './saml_assertion:AttributeValue') as $av) {
            $this->AttributeValue[] = new AttributeValue($av);
        }
    }

References $xml, and SAML2\Utils\xpQuery().

Here is the call graph for this function:

Member Function Documentation

toXML()

SAML2\XML\saml\Attribute::toXML

(

\DOMElement

$parent

)

Convert this Attribute to XML.

Parameters

\DOMElement

$parent

The element we should append this Attribute to.

Returns

\DOMElement

Reimplemented in SAML2\XML\md\RequestedAttribute.

Definition at line 119 of file Attribute.php.

    {
        return $this->toXMLInternal($parent, Constants::NS_SAML, 'saml:Attribute');
    }

References SAML2\Constants\NS_SAML, and SAML2\XML\saml\Attribute\toXMLInternal().

Here is the call graph for this function:

toXMLInternal()

SAML2\XML\saml\Attribute::toXMLInternal ( \DOMElement  $parent,   $namespace,   $name  )

protected

Internal implementation of toXML.

This function allows RequestedAttribute to specify the element name and namespace.

Parameters

\DOMElement	$parent	The element we should append this Attribute to.
string	$namespace	The namespace the element should be created in.
string	$name	The name of the element.

Returns

\DOMElement

Definition at line 84 of file Attribute.php.

    {
        assert(is_string($namespace));
        assert(is_string($name));
        assert(is_string($this->Name));
        assert(is_null($this->NameFormat) || is_string($this->NameFormat));
        assert(is_null($this->FriendlyName) || is_string($this->FriendlyName));
        assert(is_array($this->AttributeValue));
 
        $e = $parent->ownerDocument->createElementNS($namespace, $name);
        $parent->appendChild($e);
 
        $e->setAttribute('Name', $this->Name);
 
        if (isset($this->NameFormat)) {
            $e->setAttribute('NameFormat', $this->NameFormat);
        }
 
        if (isset($this->FriendlyName)) {
            $e->setAttribute('FriendlyName', $this->FriendlyName);
        }
 
        foreach ($this->AttributeValue as $av) {
            $av->toXML($e);
        }
 
        return $e;
    }

References $name, and $namespace.

Referenced by SAML2\XML\md\RequestedAttribute\toXML(), and SAML2\XML\saml\Attribute\toXML().

Here is the caller graph for this function:

Field Documentation

$AttributeValue

SAML2\XML\saml\Attribute::$AttributeValue = array()

Definition at line 43 of file Attribute.php.

$FriendlyName

SAML2\XML\saml\Attribute::$FriendlyName = null

Definition at line 34 of file Attribute.php.

$Name

SAML2\XML\saml\Attribute::$Name

Definition at line 20 of file Attribute.php.

$NameFormat

SAML2\XML\saml\Attribute::$NameFormat

Definition at line 27 of file Attribute.php.

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/XML/saml/Attribute.php