Inheritance diagram for SAML2\XML\md\RoleDescriptor:

Collaboration diagram for SAML2\XML\md\RoleDescriptor:

Data Fields
	$ID

	$validUntil

	$cacheDuration

	$protocolSupportEnumeration = array()

	$errorURL

	$Extensions = array()

	$KeyDescriptor = array()

	$Organization = null

	$ContactPerson = array()

Protected Member Functions
	__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...

Private Attributes
	$elementName

Additional Inherited Members
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...

	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...

Detailed Description

Definition at line 14 of file RoleDescriptor.php.

Constructor & Destructor Documentation

◆ __construct()

SAML2\XML\md\RoleDescriptor::__construct	(		$elementName,
		\DOMElement	$xml = `null`
	)

protected

Initialize a RoleDescriptor.

Parameters

string	$elementName	The name of this element.
\DOMElement \| null	$xml	The XML element we should load.

Exceptions

Exception

Reimplemented in SAML2\XML\md\SSODescriptorType.

Definition at line 99 of file RoleDescriptor.php.

    {
        assert(is_string($elementName));
 
        parent::__construct($xml);
        $this->elementName = $elementName;
 
        if ($xml === null) {
            return;
        }
 
        if ($xml->hasAttribute('ID')) {
            $this->ID = $xml->getAttribute('ID');
        }
        if ($xml->hasAttribute('validUntil')) {
            $this->validUntil = Utils::xsDateTimeToTimestamp($xml->getAttribute('validUntil'));
        }
        if ($xml->hasAttribute('cacheDuration')) {
            $this->cacheDuration = $xml->getAttribute('cacheDuration');
        }
 
        if (!$xml->hasAttribute('protocolSupportEnumeration')) {
            throw new \Exception('Missing protocolSupportEnumeration attribute on ' . $xml->localName);
        }
        $this->protocolSupportEnumeration = preg_split('/[\s]+/', $xml->getAttribute('protocolSupportEnumeration'));
 
        if ($xml->hasAttribute('errorURL')) {
            $this->errorURL = $xml->getAttribute('errorURL');
        }
 
        $this->Extensions = Extensions::getList($xml);
 
        foreach (Utils::xpQuery($xml, './saml_metadata:KeyDescriptor') as $kd) {
            $this->KeyDescriptor[] = new KeyDescriptor($kd);
        }
 
        $organization = Utils::xpQuery($xml, './saml_metadata:Organization');
        if (count($organization) > 1) {
            throw new \Exception('More than one Organization in the entity.');
        } elseif (!empty($organization)) {
            $this->Organization = new Organization($organization[0]);
        }
 
        foreach (Utils::xpQuery($xml, './saml_metadata:ContactPerson') as $cp) {
            $this->contactPersons[] = new ContactPerson($cp);
        }
    }

References SAML2\XML\md\RoleDescriptor\$elementName, $xml, SAML2\XML\md\Extensions\getList(), SAML2\Utils\xpQuery(), and SAML2\Utils\xsDateTimeToTimestamp().

Here is the call graph for this function:

Member Function Documentation

◆ toXML()

SAML2\XML\md\RoleDescriptor::toXML ( \DOMElement $parent )

protected

Add this RoleDescriptor to an EntityDescriptor.

Parameters

\DOMElement $parent The EntityDescriptor we should append this endpoint to.

Returns: \DOMElement

Reimplemented in SAML2\XML\md\AttributeAuthorityDescriptor, SAML2\XML\md\AuthnAuthorityDescriptor, SAML2\XML\md\IDPSSODescriptor, SAML2\XML\md\PDPDescriptor, SAML2\XML\md\SPSSODescriptor, SAML2\XML\md\SSODescriptorType, and SAML2\XML\md\UnknownRoleDescriptor.

Definition at line 153 of file RoleDescriptor.php.

    {
        assert(is_null($this->ID) || is_string($this->ID));
        assert(is_null($this->validUntil) || is_int($this->validUntil));
        assert(is_null($this->cacheDuration) || is_string($this->cacheDuration));
        assert(is_array($this->protocolSupportEnumeration));
        assert(is_null($this->errorURL) || is_string($this->errorURL));
        assert(is_array($this->Extensions));
        assert(is_array($this->KeyDescriptor));
        assert(is_null($this->Organization) || $this->Organization instanceof Organization);
        assert(is_array($this->ContactPerson));
 
        $e = $parent->ownerDocument->createElementNS(Constants::NS_MD, $this->elementName);
        $parent->appendChild($e);
 
        if (isset($this->ID)) {
            $e->setAttribute('ID', $this->ID);
        }
 
        if (isset($this->validUntil)) {
            $e->setAttribute('validUntil', gmdate('Y-m-d\TH:i:s\Z', $this->validUntil));
        }
 
        if (isset($this->cacheDuration)) {
            $e->setAttribute('cacheDuration', $this->cacheDuration);
        }
 
        $e->setAttribute('protocolSupportEnumeration', implode(' ', $this->protocolSupportEnumeration));
 
        if (isset($this->errorURL)) {
            $e->setAttribute('errorURL', $this->errorURL);
        }
 
        Extensions::addList($e, $this->Extensions);
 
        foreach ($this->KeyDescriptor as $kd) {
            $kd->toXML($e);
        }
 
        if (isset($this->Organization)) {
            $this->Organization->toXML($e);
        }
 
        foreach ($this->ContactPerson as $cp) {
            $cp->toXML($e);
        }
 
        return $e;
    }

References SAML2\XML\md\Extensions\addList(), and SAML2\Constants\NS_MD.

Here is the call graph for this function:

Field Documentation

◆ $cacheDuration

SAML2\XML\md\RoleDescriptor::$cacheDuration

Definition at line 42 of file RoleDescriptor.php.

◆ $ContactPerson

SAML2\XML\md\RoleDescriptor::$ContactPerson = array()

Definition at line 90 of file RoleDescriptor.php.

◆ $elementName

SAML2\XML\md\RoleDescriptor::$elementName

private

Definition at line 21 of file RoleDescriptor.php.

Referenced by SAML2\XML\md\RoleDescriptor\__construct(), and SAML2\XML\md\SSODescriptorType\__construct().

◆ $errorURL

SAML2\XML\md\RoleDescriptor::$errorURL

Definition at line 56 of file RoleDescriptor.php.

◆ $Extensions

SAML2\XML\md\RoleDescriptor::$Extensions = array()

Definition at line 65 of file RoleDescriptor.php.

◆ $ID

SAML2\XML\md\RoleDescriptor::$ID

Definition at line 28 of file RoleDescriptor.php.

◆ $KeyDescriptor

SAML2\XML\md\RoleDescriptor::$KeyDescriptor = array()

Definition at line 74 of file RoleDescriptor.php.

◆ $Organization

SAML2\XML\md\RoleDescriptor::$Organization = null

Definition at line 81 of file RoleDescriptor.php.

◆ $protocolSupportEnumeration

SAML2\XML\md\RoleDescriptor::$protocolSupportEnumeration = array()

Definition at line 49 of file RoleDescriptor.php.

◆ $validUntil

SAML2\XML\md\RoleDescriptor::$validUntil

Definition at line 35 of file RoleDescriptor.php.

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

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

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members