SAML2\XML\saml\AttributeValue Class Reference

Inheritance diagram for SAML2\XML\saml\AttributeValue:

Collaboration diagram for SAML2\XML\saml\AttributeValue:

Public Member Functions
	__construct ($value)
	Create an AttributeValue. More...
	toXML (\DOMElement $parent)
	Append this attribute value to an element. More...
	getString ()
	Returns a plain text content of the attribute value. More...
	__toString ()
	Convert this attribute value to a string. More...
	serialize ()
	Serialize this AttributeValue. More...
	unserialize ($serialized)
	Un-serialize this AttributeValue. More...

Data Fields
	$element

Detailed Description

Definition at line 14 of file AttributeValue.php.

Constructor & Destructor Documentation

__construct()

SAML2\XML\saml\AttributeValue::__construct

(

$value

)

Create an AttributeValue.

Parameters

mixed

$value

The value of this element. Can be one of: string Create an attribute value with a simple string. (AttributeValue) Create an attribute value of the given DOMElement. Create an attribute value with the given DOMElement as a child.

Definition at line 31 of file AttributeValue.php.

References SAML2\DOMDocumentFactory\create(), SAML2\Constants\NS_SAML, SAML2\Constants\NS_XS, and SAML2\Constants\NS_XSI.

    {
        assert(is_string($value) || $value instanceof \DOMElement);

        if (is_string($value)) {
            $doc = DOMDocumentFactory::create();
            $this->element = $doc->createElementNS(Constants::NS_SAML, 'saml:AttributeValue');
            $this->element->setAttributeNS(Constants::NS_XSI, 'xsi:type', 'xs:string');
            $this->element->appendChild($doc->createTextNode($value));

            /* Make sure that the xs-namespace is available in the AttributeValue (for xs:string). */
            $this->element->setAttributeNS(Constants::NS_XS, 'xs:tmp', 'tmp');
            $this->element->removeAttributeNS(Constants::NS_XS, 'tmp');

            return;
        }

        if ($value->namespaceURI === Constants::NS_SAML && $value->localName === 'AttributeValue') {
            $this->element = Utils::copyElement($value);

            return;
        }

        $doc = DOMDocumentFactory::create();
        $this->element = $doc->createElementNS(Constants::NS_SAML, 'saml:AttributeValue');
        Utils::copyElement($value, $this->element);
    }

Here is the call graph for this function:

Member Function Documentation

__toString()

SAML2\XML\saml\AttributeValue::__toString

(

)

Convert this attribute value to a string.

If this element contains XML data, that data will be encoded as a string and returned.

Returns

string This attribute value.

Definition at line 90 of file AttributeValue.php.

References $ret.

    {
        assert($this->element instanceof \DOMElement);

        $doc = $this->element->ownerDocument;

        $ret = '';
        foreach ($this->element->childNodes as $c) {
            $ret .= $doc->saveXML($c);
        }

        return $ret;
    }

getString()

SAML2\XML\saml\AttributeValue::getString

(

)

Returns a plain text content of the attribute value.

Definition at line 78 of file AttributeValue.php.

    {
        return $this->element->textContent;
    }

serialize()

SAML2\XML\saml\AttributeValue::serialize

(

)

Serialize this AttributeValue.

Returns

string The AttributeValue serialized.

Definition at line 110 of file AttributeValue.php.

    {
        return serialize($this->element->ownerDocument->saveXML($this->element));
    }

toXML()

SAML2\XML\saml\AttributeValue::toXML

(

\DOMElement

$parent

)

Append this attribute value to an element.

Parameters

\DOMElement

$parent

The element we should append this attribute value to.

Returns

The generated AttributeValue element.

Definition at line 65 of file AttributeValue.php.

References SAML2\Constants\NS_SAML.

    {
        assert($this->element instanceof \DOMElement);
        assert($this->element->namespaceURI === \SAML2\Constants::NS_SAML && $this->element->localName === "AttributeValue");

        $v = Utils::copyElement($this->element, $parent);

        return $v;
    }

unserialize()

SAML2\XML\saml\AttributeValue::unserialize

(

$serialized

)

Un-serialize this AttributeValue.

Parameters

string

$serialized

The serialized AttributeValue.

Definition at line 121 of file AttributeValue.php.

References SAML2\DOMDocumentFactory\fromString().

    {
        $doc = DOMDocumentFactory::fromString(unserialize($serialized));
        $this->element = $doc->documentElement;
    }

Here is the call graph for this function:

Field Documentation

$element

SAML2\XML\saml\AttributeValue::$element

Definition at line 21 of file AttributeValue.php.

---

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

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