SAML2\XML\md\AffiliationDescriptor Class Reference

Inheritance diagram for SAML2\XML\md\AffiliationDescriptor:

Collaboration diagram for SAML2\XML\md\AffiliationDescriptor:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Initialize a AffiliationDescriptor. More...
	toXML (\DOMElement $parent)
	Add this AffiliationDescriptor 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...
	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
	$affiliationOwnerID
	$ID
	$validUntil
	$cacheDuration
	$Extensions = array()
	$AffiliateMember = array()
	$KeyDescriptor = 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 14 of file AffiliationDescriptor.php.

Constructor & Destructor Documentation

__construct()

SAML2\XML\md\AffiliationDescriptor::__construct

(

\DOMElement

$xml = null

)

Initialize a AffiliationDescriptor.

Parameters

\DOMElement | null

$xml

The XML element we should load.

Exceptions

Exception

Reimplemented from SAML2\SignedElementHelper.

Definition at line 77 of file AffiliationDescriptor.php.

    {
        parent::__construct($xml);
 
        if ($xml === null) {
            return;
        }
 
        if (!$xml->hasAttribute('affiliationOwnerID')) {
            throw new \Exception('Missing affiliationOwnerID on AffiliationDescriptor.');
        }
        $this->affiliationOwnerID = $xml->getAttribute('affiliationOwnerID');
 
        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);
 
        $this->AffiliateMember = Utils::extractStrings($xml, Constants::NS_MD, 'AffiliateMember');
        if (empty($this->AffiliateMember)) {
            throw new \Exception('Missing AffiliateMember in AffiliationDescriptor.');
        }
 
        foreach (Utils::xpQuery($xml, './saml_metadata:KeyDescriptor') as $kd) {
            $this->KeyDescriptor[] = new KeyDescriptor($kd);
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

toXML()

SAML2\XML\md\AffiliationDescriptor::toXML

(

\DOMElement

$parent

)

Add this AffiliationDescriptor to an EntityDescriptor.

Parameters

\DOMElement

$parent

The EntityDescriptor we should append this endpoint to.

Returns

\DOMElement

Definition at line 120 of file AffiliationDescriptor.php.

    {
        assert(is_string($this->affiliationOwnerID));
        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->Extensions));
        assert(is_array($this->AffiliateMember));
        assert(!empty($this->AffiliateMember));
        assert(is_array($this->KeyDescriptor));
 
        $e = $parent->ownerDocument->createElementNS(Constants::NS_MD, 'md:AffiliationDescriptor');
        $parent->appendChild($e);
 
        $e->setAttribute('affiliationOwnerID', $this->affiliationOwnerID);
 
        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);
        }
 
        Extensions::addList($e, $this->Extensions);
 
        Utils::addStrings($e, Constants::NS_MD, 'md:AffiliateMember', false, $this->AffiliateMember);
 
        foreach ($this->KeyDescriptor as $kd) {
            $kd->toXML($e);
        }
 
        $this->signElement($e, $e->firstChild);
 
        return $e;
    }

References SAML2\XML\md\Extensions\addList(), SAML2\Utils\addStrings(), SAML2\Constants\NS_MD, and SAML2\SignedElementHelper\signElement().

Here is the call graph for this function:

Field Documentation

$AffiliateMember

SAML2\XML\md\AffiliationDescriptor::$AffiliateMember = array()

Definition at line 60 of file AffiliationDescriptor.php.

$affiliationOwnerID

SAML2\XML\md\AffiliationDescriptor::$affiliationOwnerID

Definition at line 21 of file AffiliationDescriptor.php.

$cacheDuration

SAML2\XML\md\AffiliationDescriptor::$cacheDuration

Definition at line 42 of file AffiliationDescriptor.php.

$Extensions

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

Definition at line 51 of file AffiliationDescriptor.php.

$ID

SAML2\XML\md\AffiliationDescriptor::$ID

Definition at line 28 of file AffiliationDescriptor.php.

$KeyDescriptor

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

Definition at line 69 of file AffiliationDescriptor.php.

$validUntil

SAML2\XML\md\AffiliationDescriptor::$validUntil

Definition at line 35 of file AffiliationDescriptor.php.

---

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

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