SAML2\XML\md\ContactPerson Class Reference

Collaboration diagram for SAML2\XML\md\ContactPerson:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Initialize a ContactPerson element. More...
	toXML (\DOMElement $parent)
	Convert this ContactPerson to XML. More...

Data Fields
	$contactType
	$Extensions = array()
	$Company = null
	$GivenName = null
	$SurName = null
	$EmailAddress = array()
	$TelephoneNumber = array()
	$ContactPersonAttributes = array()

Static Private Member Functions
static	getStringElements (\DOMElement $parent, $name)
	Retrieve the value of a child as an array of strings. More...
static	getStringElement (\DOMElement $parent, $name)
	Retrieve the value of a child as a string. More...

Detailed Description

Definition at line 13 of file ContactPerson.php.

Constructor & Destructor Documentation

__construct()

SAML2\XML\md\ContactPerson::__construct

(

\DOMElement

$xml = null

)

Initialize a ContactPerson element.

Parameters

\DOMElement | null

$xml

The XML element we should load.

Exceptions

Definition at line 79 of file ContactPerson.php.

References $xml, and SAML2\XML\md\Extensions\getList().

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

        if (!$xml->hasAttribute('contactType')) {
            throw new \Exception('Missing contactType on ContactPerson.');
        }
        $this->contactType = $xml->getAttribute('contactType');

        $this->Extensions = Extensions::getList($xml);

        $this->Company = self::getStringElement($xml, 'Company');
        $this->GivenName = self::getStringElement($xml, 'GivenName');
        $this->SurName = self::getStringElement($xml, 'SurName');
        $this->EmailAddress = self::getStringElements($xml, 'EmailAddress');
        $this->TelephoneNumber = self::getStringElements($xml, 'TelephoneNumber');

        foreach ($xml->attributes as $attr) {
            if ($attr->nodeName == "contactType") {
                continue;
            }

            $this->ContactPersonAttributes[$attr->nodeName] = $attr->nodeValue;
        }
    }

Here is the call graph for this function:

Member Function Documentation

getStringElement()

static SAML2\XML\md\ContactPerson::getStringElement ( \DOMElement  $parent,   $name  )

staticprivate

Retrieve the value of a child as a string.

Parameters

\DOMElement	$parent	The parent element.
string	$name	The name of the child element.

Returns

string|null The value of the child element.

Exceptions

Definition at line 136 of file ContactPerson.php.

References $name.

    {
        assert(is_string($name));

        $e = self::getStringElements($parent, $name);
        if (empty($e)) {
            return null;
        }
        if (count($e) > 1) {
            throw new \Exception('More than one ' . $name . ' in ' . $parent->tagName);
        }

        return $e[0];
    }

getStringElements()

static SAML2\XML\md\ContactPerson::getStringElements ( \DOMElement  $parent,   $name  )

staticprivate

Retrieve the value of a child as an array of strings.

Parameters

\DOMElement	$parent	The parent element.
string	$name	The name of the child elements.

Returns

array The value of the child elements.

Definition at line 114 of file ContactPerson.php.

References $i, $name, $ret, array, and SAML2\Utils\xpQuery().

    {
        assert(is_string($name));

        $e = Utils::xpQuery($parent, './saml_metadata:' . $name);

        $ret = array();
        foreach ($e as $i) {
            $ret[] = $i->textContent;
        }

        return $ret;
    }

Here is the call graph for this function:

toXML()

SAML2\XML\md\ContactPerson::toXML

(

\DOMElement

$parent

)

Convert this ContactPerson to XML.

Parameters

\DOMElement

$parent

The element we should add this contact to.

Returns

The new ContactPerson-element.

Definition at line 157 of file ContactPerson.php.

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

    {
        assert(is_string($this->contactType));
        assert(is_array($this->Extensions));
        assert(is_null($this->Company) || is_string($this->Company));
        assert(is_null($this->GivenName) || is_string($this->GivenName));
        assert(is_null($this->SurName) || is_string($this->SurName));
        assert(is_array($this->EmailAddress));
        assert(is_array($this->TelephoneNumber));
        assert(is_array($this->ContactPersonAttributes));

        $doc = $parent->ownerDocument;

        $e = $doc->createElementNS(Constants::NS_MD, 'md:ContactPerson');
        $parent->appendChild($e);

        $e->setAttribute('contactType', $this->contactType);

        foreach ($this->ContactPersonAttributes as $attr => $val) {
            $e->setAttribute($attr, $val);
        }

        Extensions::addList($e, $this->Extensions);

        if (isset($this->Company)) {
            Utils::addString($e, Constants::NS_MD, 'md:Company', $this->Company);
        }
        if (isset($this->GivenName)) {
            Utils::addString($e, Constants::NS_MD, 'md:GivenName', $this->GivenName);
        }
        if (isset($this->SurName)) {
            Utils::addString($e, Constants::NS_MD, 'md:SurName', $this->SurName);
        }
        if (!empty($this->EmailAddress)) {
            Utils::addStrings($e, Constants::NS_MD, 'md:EmailAddress', false, $this->EmailAddress);
        }
        if (!empty($this->TelephoneNumber)) {
            Utils::addStrings($e, Constants::NS_MD, 'md:TelephoneNumber', false, $this->TelephoneNumber);
        }

        return $e;
    }

Here is the call graph for this function:

Field Documentation

$Company

SAML2\XML\md\ContactPerson::$Company = null

Definition at line 36 of file ContactPerson.php.

$ContactPersonAttributes

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

Definition at line 71 of file ContactPerson.php.

$contactType

SAML2\XML\md\ContactPerson::$contactType

Definition at line 20 of file ContactPerson.php.

$EmailAddress

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

Definition at line 57 of file ContactPerson.php.

$Extensions

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

Definition at line 29 of file ContactPerson.php.

$GivenName

SAML2\XML\md\ContactPerson::$GivenName = null

Definition at line 43 of file ContactPerson.php.

$SurName

SAML2\XML\md\ContactPerson::$SurName = null

Definition at line 50 of file ContactPerson.php.

$TelephoneNumber

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

Definition at line 64 of file ContactPerson.php.

---

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

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