SAML2\AttributeQuery Class Reference

Inheritance diagram for SAML2\AttributeQuery:

Collaboration diagram for SAML2\AttributeQuery:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Constructor for SAML 2 attribute query messages. More...
	getAttributes ()
	Retrieve all requested attributes. More...
	setAttributes (array $attributes)
	Set all requested attributes. More...
	getAttributeNameFormat ()
	Retrieve the NameFormat used on all attributes. More...
	setAttributeNameFormat ($nameFormat)
	Set the NameFormat used on all attributes. More...
	toUnsignedXML ()
	Convert the attribute query message to an XML element. More...
Public Member Functions inherited from SAML2\SubjectQuery
	getNameId ()
	Retrieve the NameId of the subject in the query. More...
	setNameId ($nameId)
	Set the NameId of the subject in the query. More...
	toUnsignedXML ()
	Convert subject query message to an XML element. More...
Public Member Functions inherited from SAML2\Message
	addValidator ($function, $data)
	Add a method for validating this message. More...
	validate (XMLSecurityKey $key)
	Validate this message against a public key. More...
	getId ()
	Retrieve the identifier of this message. More...
	setId ($id)
	Set the identifier of this message. More...
	getIssueInstant ()
	Retrieve the issue timestamp of this message. More...
	setIssueInstant ($issueInstant)
	Set the issue timestamp of this message. More...
	getDestination ()
	Retrieve the destination of this message. More...
	setDestination ($destination)
	Set the destination of this message. More...
	setConsent ($consent)
	Set the given consent for this message. More...
	getConsent ()
	Set the given consent for this message. More...
	getIssuer ()
	Retrieve the issuer if this message. More...
	setIssuer ($issuer)
	Set the issuer of this message. More...
	isMessageConstructedWithSignature ()
	Query whether or not the message contained a signature at the root level when the object was constructed. More...
	getRelayState ()
	Retrieve the RelayState associated with this message. More...
	setRelayState ($relayState)
	Set the RelayState associated with this message. More...
	toUnsignedXML ()
	Convert this message to an unsigned XML document. More...
	toSignedXML ()
	Convert this message to a signed XML document. More...
	getSignatureKey ()
	Retrieve the private key we should use to sign the message. More...
	setSignatureKey (XMLSecurityKey $signatureKey=null)
	Set the private key we should use to sign the message. More...
	setCertificates (array $certificates)
	Set the certificates that should be included in the message. More...
	getCertificates ()
	Retrieve the certificates that are included in the message. More...
	getExtensions ()
	Retrieve the Extensions. More...
	setExtensions ($extensions)
	Set the Extensions. More...
	getSignatureMethod ()
	validate (XMLSecurityKey $key)
	Validate this element against a public key. More...
	setCertificates (array $certificates)
	Set the certificates that should be included in the element. More...
	getCertificates ()
	Retrieve the certificates that are included in the element (if any). More...
	getSignatureKey ()
	Retrieve the private key we should use to sign the element. More...
	setSignatureKey (XMLSecurityKey $signatureKey=null)
	Set the private key we should use to sign the element. More...

Private Attributes
	$attributes
	$nameFormat

Additional Inherited Members
Static Public Member Functions inherited from SAML2\Message
static	fromXML (\DOMElement $xml)
	Convert an XML element into a message. More...
Protected Member Functions inherited from SAML2\SubjectQuery
	__construct ($tagName, \DOMElement $xml=null)
	Constructor for SAML 2 subject query messages. More...
	__construct ($tagName, \DOMElement $xml=null)
	Initialize a message. More...
Protected Attributes inherited from SAML2\Message
	$extensions
	$document
	$messageContainedSignatureUponConstruction = false

Detailed Description

Definition at line 20 of file AttributeQuery.php.

Constructor & Destructor Documentation

__construct()

SAML2\AttributeQuery::__construct

(

\DOMElement

$xml = null

)

Constructor for SAML 2 attribute query messages.

Parameters

\DOMElement | null

$xml

The input message.

Exceptions

Exception

Definition at line 45 of file AttributeQuery.php.

    {
        parent::__construct('AttributeQuery', $xml);
 
        $this->attributes = array();
        $this->nameFormat = Constants::NAMEFORMAT_UNSPECIFIED;
 
        if ($xml === null) {
            return;
        }
 
        $firstAttribute = true;
        $attributes = Utils::xpQuery($xml, './saml_assertion:Attribute');
        foreach ($attributes as $attribute) {
            if (!$attribute->hasAttribute('Name')) {
                throw new \Exception('Missing name on <saml:Attribute> element.');
            }
            $name = $attribute->getAttribute('Name');
 
            if ($attribute->hasAttribute('NameFormat')) {
                $nameFormat = $attribute->getAttribute('NameFormat');
            } else {
                $nameFormat = Constants::NAMEFORMAT_UNSPECIFIED;
            }
 
            if ($firstAttribute) {
                $this->nameFormat = $nameFormat;
                $firstAttribute = false;
            } else {
                if ($this->nameFormat !== $nameFormat) {
                    $this->nameFormat = Constants::NAMEFORMAT_UNSPECIFIED;
                }
            }
 
            if (!array_key_exists($name, $this->attributes)) {
                $this->attributes[$name] = array();
            }
 
            $values = Utils::xpQuery($attribute, './saml_assertion:AttributeValue');
            foreach ($values as $value) {
                $this->attributes[$name][] = trim($value->textContent);
            }
        }
    }

References $attributes, $name, and $xml.

Member Function Documentation

getAttributeNameFormat()

SAML2\AttributeQuery::getAttributeNameFormat

(

)

Retrieve the NameFormat used on all attributes.

If more than one NameFormat is used in the received attributes, this returns the unspecified NameFormat.

Returns

string The NameFormat used on all attributes.

Definition at line 118 of file AttributeQuery.php.

    {
        return $this->nameFormat;
    }

getAttributes()

SAML2\AttributeQuery::getAttributes

(

)

Retrieve all requested attributes.

Returns

array All requested attributes, as an associative array.

Definition at line 95 of file AttributeQuery.php.

    {
        return $this->attributes;
    }

References $attributes.

setAttributeNameFormat()

SAML2\AttributeQuery::setAttributeNameFormat

(

$nameFormat

)

Set the NameFormat used on all attributes.

Parameters

string

$nameFormat

The NameFormat used on all attributes.

Definition at line 128 of file AttributeQuery.php.

    {
        assert(is_string($nameFormat));
 
        $this->nameFormat = $nameFormat;
    }

setAttributes()

SAML2\AttributeQuery::setAttributes

(

array

$attributes

)

Set all requested attributes.

Parameters

array

$attributes

All requested attributes, as an associative array.

Definition at line 105 of file AttributeQuery.php.

    {
        $this->attributes = $attributes;
    }

References $attributes.

toUnsignedXML()

SAML2\AttributeQuery::toUnsignedXML

(

)

Convert the attribute query message to an XML element.

Returns

\DOMElement This attribute query.

Reimplemented from SAML2\SubjectQuery.

Definition at line 140 of file AttributeQuery.php.

    {
        $root = parent::toUnsignedXML();
 
        foreach ($this->attributes as $name => $values) {
            $attribute = $root->ownerDocument->createElementNS(Constants::NS_SAML, 'saml:Attribute');
            $root->appendChild($attribute);
            $attribute->setAttribute('Name', $name);
 
            if ($this->nameFormat !== Constants::NAMEFORMAT_UNSPECIFIED) {
                $attribute->setAttribute('NameFormat', $this->nameFormat);
            }
 
            foreach ($values as $value) {
                if (is_string($value)) {
                    $type = 'xs:string';
                } elseif (is_int($value)) {
                    $type = 'xs:integer';
                } else {
                    $type = null;
                }
 
                $attributeValue = Utils::addString($attribute, Constants::NS_SAML, 'saml:AttributeValue', $value);
                if ($type !== null) {
                    $attributeValue->setAttributeNS(Constants::NS_XSI, 'xsi:type', $type);
                }
            }
        }
 
        return $root;
    }

References $name, and $type.

Field Documentation

$attributes

SAML2\AttributeQuery::$attributes

private

Definition at line 27 of file AttributeQuery.php.

$nameFormat

SAML2\AttributeQuery::$nameFormat

private

Definition at line 37 of file AttributeQuery.php.

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/AttributeQuery.php