SAML2\XML\md\EntityDescriptor Class Reference

Inheritance diagram for SAML2\XML\md\EntityDescriptor:

Collaboration diagram for SAML2\XML\md\EntityDescriptor:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Initialize an EntitiyDescriptor. 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...
	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...

Data Fields
	$entityID
	$ID
	$validUntil
	$cacheDuration
	$Extensions = array()
	$RoleDescriptor = array()
	$AffiliationDescriptor = null
	$Organization = null
	$ContactPerson = array()
	$AdditionalMetadataLocation = array()

Additional Inherited Members
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 15 of file EntityDescriptor.php.

Constructor & Destructor Documentation

__construct()

SAML2\XML\md\EntityDescriptor::__construct

(

\DOMElement

$xml = null

)

Initialize an EntitiyDescriptor.

Parameters

\DOMElement | null

$xml

The XML element we should load.

Exceptions

Exception

Reimplemented from SAML2\SignedElementHelper.

Definition at line 97 of file EntityDescriptor.php.

    {
        parent::__construct($xml);
 
        if ($xml === null) {
            return;
        }
 
        if (!$xml->hasAttribute('entityID')) {
            throw new \Exception('Missing required attribute entityID on EntityDescriptor.');
        }
        $this->entityID = $xml->getAttribute('entityID');
 
        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');
        }
 
        $this->Extensions = Extensions::getList($xml);
 
        for ($node = $xml->firstChild; $node !== null; $node = $node->nextSibling) {
            if (!($node instanceof \DOMElement)) {
                continue;
            }
 
            if ($node->namespaceURI !== Constants::NS_MD) {
                continue;
            }
 
            switch ($node->localName) {
                case 'RoleDescriptor':
                    $this->RoleDescriptor[] = new UnknownRoleDescriptor($node);
                    break;
                case 'IDPSSODescriptor':
                    $this->RoleDescriptor[] = new IDPSSODescriptor($node);
                    break;
                case 'SPSSODescriptor':
                    $this->RoleDescriptor[] = new SPSSODescriptor($node);
                    break;
                case 'AuthnAuthorityDescriptor':
                    $this->RoleDescriptor[] = new AuthnAuthorityDescriptor($node);
                    break;
                case 'AttributeAuthorityDescriptor':
                    $this->RoleDescriptor[] = new AttributeAuthorityDescriptor($node);
                    break;
                case 'PDPDescriptor':
                    $this->RoleDescriptor[] = new PDPDescriptor($node);
                    break;
            }
        }
 
        $affiliationDescriptor = Utils::xpQuery($xml, './saml_metadata:AffiliationDescriptor');
        if (count($affiliationDescriptor) > 1) {
            throw new \Exception('More than one AffiliationDescriptor in the entity.');
        } elseif (!empty($affiliationDescriptor)) {
            $this->AffiliationDescriptor = new AffiliationDescriptor($affiliationDescriptor[0]);
        }
 
        if (empty($this->RoleDescriptor) && is_null($this->AffiliationDescriptor)) {
            throw new \Exception('Must have either one of the RoleDescriptors or an AffiliationDescriptor in EntityDescriptor.');
        } elseif (!empty($this->RoleDescriptor) && !is_null($this->AffiliationDescriptor)) {
            throw new \Exception('AffiliationDescriptor cannot be combined with other RoleDescriptor elements in EntityDescriptor.');
        }
 
        $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->ContactPerson[] = new ContactPerson($cp);
        }
 
        foreach (Utils::xpQuery($xml, './saml_metadata:AdditionalMetadataLocation') as $aml) {
            $this->AdditionalMetadataLocation[] = new AdditionalMetadataLocation($aml);
        }
    }

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

Here is the call graph for this function:

Field Documentation

$AdditionalMetadataLocation

SAML2\XML\md\EntityDescriptor::$AdditionalMetadataLocation = array()

Definition at line 89 of file EntityDescriptor.php.

$AffiliationDescriptor

SAML2\XML\md\EntityDescriptor::$AffiliationDescriptor = null

Definition at line 68 of file EntityDescriptor.php.

$cacheDuration

SAML2\XML\md\EntityDescriptor::$cacheDuration

Definition at line 43 of file EntityDescriptor.php.

$ContactPerson

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

Definition at line 82 of file EntityDescriptor.php.

$entityID

SAML2\XML\md\EntityDescriptor::$entityID

Definition at line 22 of file EntityDescriptor.php.

$Extensions

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

Definition at line 52 of file EntityDescriptor.php.

$ID

SAML2\XML\md\EntityDescriptor::$ID

Definition at line 29 of file EntityDescriptor.php.

$Organization

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

Definition at line 75 of file EntityDescriptor.php.

$RoleDescriptor

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

Definition at line 61 of file EntityDescriptor.php.

$validUntil

SAML2\XML\md\EntityDescriptor::$validUntil

Definition at line 36 of file EntityDescriptor.php.

---

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

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