SAML2\XML\md\SPSSODescriptor Class Reference

Inheritance diagram for SAML2\XML\md\SPSSODescriptor:

Collaboration diagram for SAML2\XML\md\SPSSODescriptor:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Initialize a SPSSODescriptor. More...
	toXML (\DOMElement $parent)
	Add this SPSSODescriptor to an EntityDescriptor. More...
Public Member Functions inherited from SAML2\SignedElementHelper
	addValidator ($function, $data)
	Add a method for validating this element. More...
	validate (XMLSecurityKey $key)
	Validate this element against a public key. 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...
	getValidatingCertificates ()
	Retrieve certificates that sign this element. More...

Data Fields
	$AuthnRequestsSigned = null
	$WantAssertionsSigned = null
	$AssertionConsumerService = array()
	$AttributeConsumingService = array()
Data Fields inherited from SAML2\XML\md\SSODescriptorType
	$ArtifactResolutionService = array()
	$SingleLogoutService = array()
	$ManageNameIDService = array()
	$NameIDFormat = array()
Data Fields inherited from SAML2\XML\md\RoleDescriptor
	$ID
	$validUntil
	$cacheDuration
	$protocolSupportEnumeration = array()
	$errorURL
	$Extensions = array()
	$KeyDescriptor = array()
	$Organization = null
	$ContactPerson = array()

Additional Inherited Members
Protected Member Functions inherited from SAML2\XML\md\SSODescriptorType
	__construct ($elementName, \DOMElement $xml=null)
	Initialize a SSODescriptor. More...
	toXML (\DOMElement $parent)
	Add this SSODescriptorType to an EntityDescriptor. More...
Protected Member Functions inherited from SAML2\XML\md\RoleDescriptor
	__construct ($elementName, \DOMElement $xml=null)
	Initialize a RoleDescriptor. More...
	toXML (\DOMElement $parent)
	Add this RoleDescriptor to an EntityDescriptor. More...
Protected Member Functions inherited from SAML2\SignedElementHelper
	__construct (\DOMElement $xml=null)
	Initialize the helper class. More...
	signElement (\DOMElement $root, \DOMElement $insertBefore=null)
	Sign the given XML element. More...

Detailed Description

Definition at line 12 of file SPSSODescriptor.php.

Constructor & Destructor Documentation

__construct()

SAML2\XML\md\SPSSODescriptor::__construct

(

\DOMElement

$xml = null

)

Initialize a SPSSODescriptor.

Parameters

\DOMElement | null

$xml

The XML element we should load.

Definition at line 51 of file SPSSODescriptor.php.

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

    {
        parent::__construct('md:SPSSODescriptor', $xml);

        if ($xml === null) {
            return;
        }

        $this->AuthnRequestsSigned = Utils::parseBoolean($xml, 'AuthnRequestsSigned', null);
        $this->WantAssertionsSigned = Utils::parseBoolean($xml, 'WantAssertionsSigned', null);

        foreach (Utils::xpQuery($xml, './saml_metadata:AssertionConsumerService') as $ep) {
            $this->AssertionConsumerService[] = new IndexedEndpointType($ep);
        }

        foreach (Utils::xpQuery($xml, './saml_metadata:AttributeConsumingService') as $acs) {
            $this->AttributeConsumingService[] = new AttributeConsumingService($acs);
        }
    }

Here is the call graph for this function:

Member Function Documentation

toXML()

SAML2\XML\md\SPSSODescriptor::toXML

(

\DOMElement

$parent

)

Add this SPSSODescriptor to an EntityDescriptor.

Parameters

\DOMElement

$parent

The EntityDescriptor we should append this SPSSODescriptor to.

Returns

void

Definition at line 77 of file SPSSODescriptor.php.

    {
        assert(is_null($this->AuthnRequestsSigned) || is_bool($this->AuthnRequestsSigned));
        assert(is_null($this->WantAssertionsSigned) || is_bool($this->WantAssertionsSigned));
        assert(is_array($this->AssertionConsumerService));
        assert(is_array($this->AttributeConsumingService));

        $e = parent::toXML($parent);

        if ($this->AuthnRequestsSigned === true) {
            $e->setAttribute('AuthnRequestsSigned', 'true');
        } elseif ($this->AuthnRequestsSigned === false) {
            $e->setAttribute('AuthnRequestsSigned', 'false');
        }

        if ($this->WantAssertionsSigned === true) {
            $e->setAttribute('WantAssertionsSigned', 'true');
        } elseif ($this->WantAssertionsSigned === false) {
            $e->setAttribute('WantAssertionsSigned', 'false');
        }

        foreach ($this->AssertionConsumerService as $ep) {
            $ep->toXML($e, 'md:AssertionConsumerService');
        }

        foreach ($this->AttributeConsumingService as $acs) {
            $acs->toXML($e);
        }
    }

Field Documentation

$AssertionConsumerService

SAML2\XML\md\SPSSODescriptor::$AssertionConsumerService = array()

Definition at line 35 of file SPSSODescriptor.php.

$AttributeConsumingService

SAML2\XML\md\SPSSODescriptor::$AttributeConsumingService = array()

Definition at line 44 of file SPSSODescriptor.php.

$AuthnRequestsSigned

SAML2\XML\md\SPSSODescriptor::$AuthnRequestsSigned = null

Definition at line 19 of file SPSSODescriptor.php.

$WantAssertionsSigned

SAML2\XML\md\SPSSODescriptor::$WantAssertionsSigned = null

Definition at line 26 of file SPSSODescriptor.php.

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/XML/md/SPSSODescriptor.php