SimpleSAML\XML\Parser Class Reference

Collaboration diagram for SimpleSAML\XML\Parser:

Public Member Functions
	__construct ($xml)
	getValueDefault ($xpath, $defvalue)
	getValue ($xpath, $required=false)
	getValueAlternatives (array $xpath, $required=false)

Static Public Member Functions
static	fromSimpleXMLElement (\SimpleXMLElement $element)

Data Fields
	$simplexml = null

Detailed Description

Definition at line 12 of file Parser.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\XML\Parser::__construct

(

$xml

)

Definition at line 16 of file Parser.php.

References $xml.

    {
        ;
        $this->simplexml = new \SimpleXMLElement($xml);
        $this->simplexml->registerXPathNamespace('saml2', 'urn:oasis:names:tc:SAML:2.0:assertion');
        $this->simplexml->registerXPathNamespace('saml2meta', 'urn:oasis:names:tc:SAML:2.0:metadata');
        $this->simplexml->registerXPathNamespace('ds', 'http://www.w3.org/2000/09/xmldsig#');
    }

Member Function Documentation

fromSimpleXMLElement()

static SimpleSAML\XML\Parser::fromSimpleXMLElement ( \SimpleXMLElement  $element )

static

Definition at line 25 of file Parser.php.

References $parser.

    {
        
        // Traverse all existing namespaces in element
        $namespaces = $element->getNamespaces();
        foreach ($namespaces as $prefix => $ns) {
            $element[(($prefix === '') ? 'xmlns' : 'xmlns:' . $prefix)] = $ns;
        }
        
        /* Create a new parser with the xml document where the namespace definitions
         * are added.
         */
        $parser = new Parser($element->asXML());
        return $parser;
    }

getValue()

SimpleSAML\XML\Parser::getValue	(		$xpath,
			$required = false
	)

Definition at line 50 of file Parser.php.

References $result.

Referenced by SimpleSAML\XML\Parser\getValueAlternatives(), and SimpleSAML\XML\Parser\getValueDefault().

    {
        $result = $this->simplexml->xpath($xpath);
        if (!is_array($result) || empty($result)) {
            if ($required) {
                throw new \Exception('Could not get value from XML document using the following XPath expression: ' . $xpath);
            } else {
                return null;
            }
        }
        return (string) $result[0];
    }

Here is the caller graph for this function:

getValueAlternatives()

SimpleSAML\XML\Parser::getValueAlternatives	(	array	$xpath,
			$required = false
	)

Definition at line 63 of file Parser.php.

References $x, and SimpleSAML\XML\Parser\getValue().

    {
        foreach ($xpath as $x) {
            $seek = $this->getValue($x);
            if ($seek) {
                return $seek;
            }
        }
        if ($required) {
            throw new \Exception('Could not get value from XML document using multiple alternative XPath expressions.');
        } else {
            return null;
        }
    }

Here is the call graph for this function:

getValueDefault()

SimpleSAML\XML\Parser::getValueDefault	(		$xpath,
			$defvalue
	)

Definition at line 41 of file Parser.php.

References SimpleSAML\XML\Parser\getValue().

    {
        try {
            return $this->getValue($xpath, true);
        } catch (\Exception $e) {
            return $defvalue;
        }
    }

Here is the call graph for this function:

Field Documentation

$simplexml

SimpleSAML\XML\Parser::$simplexml = null

Definition at line 14 of file Parser.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/XML/Parser.php