ilSamlIdpXmlMetadataParser Class Reference

Collaboration diagram for ilSamlIdpXmlMetadataParser:

Public Member Functions
	__construct (DataTypeFactory $dataFactory, ilSamlIdpXmlMetadataErrorFormatter $errorFormatter)
	parse (string $xmlString)
	result ()

Private Member Functions
	beginLogging ()
	addErrors ()
	endLogging ()

Private Attributes
DataTypeFactory	$dataFactory
ilSamlIdpXmlMetadataErrorFormatter	$errorFormatter
Result	$result
bool	$xmlErrorState = false
array	$errorStack = []

Detailed Description

Definition at line 24 of file class.ilSamlIdpXmlMetadataParser.php.

Constructor & Destructor Documentation

__construct()

ilSamlIdpXmlMetadataParser::__construct	(	DataTypeFactory	$dataFactory,
		ilSamlIdpXmlMetadataErrorFormatter	$errorFormatter
	)

Definition at line 33 of file class.ilSamlIdpXmlMetadataParser.php.

    {
        $this->dataFactory = $dataFactory;
        $this->errorFormatter = $errorFormatter;
        $this->result = new Result\Error('No metadata parsed, yet');
    }

References $dataFactory, $errorFormatter, and result().

Here is the call graph for this function:

Member Function Documentation

addErrors()

ilSamlIdpXmlMetadataParser::addErrors ( )

private

Definition at line 52 of file class.ilSamlIdpXmlMetadataParser.php.

                                : void
    {
        $currentErrors = libxml_get_errors();
        libxml_clear_errors();
 
        $level = count($this->errorStack) - 1;
        $this->errorStack[$level] = array_merge($this->errorStack[$level], $currentErrors);
    }

Referenced by beginLogging(), and endLogging().

Here is the caller graph for this function:

beginLogging()

ilSamlIdpXmlMetadataParser::beginLogging ( )

private

Definition at line 40 of file class.ilSamlIdpXmlMetadataParser.php.

                                   : void
    {
        if (0 === count($this->errorStack)) {
            $this->xmlErrorState = libxml_use_internal_errors(true);
            libxml_clear_errors();
        } else {
            $this->addErrors();
        }
 
        $this->errorStack[] = [];
    }

References addErrors().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

endLogging()

ilSamlIdpXmlMetadataParser::endLogging ( )

private

Returns

LibXMLError[] An array with the LibXMLErrors which has occurred since beginLogging() was called.

Definition at line 64 of file class.ilSamlIdpXmlMetadataParser.php.

                                 : array
    {
        $this->addErrors();
 
        $errors = array_pop($this->errorStack);
 
        if (0 === count($this->errorStack)) {
            libxml_use_internal_errors($this->xmlErrorState);
        }
 
        return $errors;
    }

References $errors, and addErrors().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

parse()

ilSamlIdpXmlMetadataParser::parse

(

string

$xmlString

)

Definition at line 77 of file class.ilSamlIdpXmlMetadataParser.php.

                                            : void
    {
        try {
            $this->beginLogging();
 
            $xml = new SimpleXMLElement($xmlString);
 
            $xml->registerXPathNamespace('md', 'urn:oasis:names:tc:SAML:2.0:metadata');
            $xml->registerXPathNamespace('mdui', 'urn:oasis:names:tc:SAML:metadata:ui');
 
            $idps = $xml->xpath('//md:EntityDescriptor[//md:IDPSSODescriptor]');
            $entityId = null;
            if ($idps && is_array($idps) && isset($idps[0]) && $idps[0] instanceof SimpleXMLElement) {
                $attributes = $idps[0]->attributes('', true);
                if ($attributes && isset($attributes['entityID'])) {
                    $entityId = (string) ($attributes->entityID[0] ?? '');
                }
            }
 
            $errors = $this->endLogging();
 
            if ($entityId) {
                $this->result = $this->dataFactory->ok($entityId);
                return;
            }
 
            $error = new LibXMLError();
            $error->level = LIBXML_ERR_FATAL;
            $error->code = 0;
            $error->message = 'No entityID found';
            $error->line = 1;
            $error->column = 0;
 
            $errors[] = $error;
 
            $this->result = $this->dataFactory->error($this->errorFormatter->formatErrors(...$errors));
        } catch (Exception $e) {
            $this->result = $this->dataFactory->error($this->errorFormatter->formatErrors(...$this->endLogging()));
        }
    }

References $attributes, Vendor\Package\$e, $entityId, $errors, $xml, beginLogging(), endLogging(), and result().

Here is the call graph for this function:

result()

ilSamlIdpXmlMetadataParser::result

(

)

Definition at line 118 of file class.ilSamlIdpXmlMetadataParser.php.

                            : Result
    {
        return $this->result;
    }

References $result.

Referenced by __construct(), and parse().

Here is the caller graph for this function:

Field Documentation

$dataFactory

DataTypeFactory ilSamlIdpXmlMetadataParser::$dataFactory

private

Definition at line 26 of file class.ilSamlIdpXmlMetadataParser.php.

Referenced by __construct().

$errorFormatter

ilSamlIdpXmlMetadataErrorFormatter ilSamlIdpXmlMetadataParser::$errorFormatter

private

Definition at line 27 of file class.ilSamlIdpXmlMetadataParser.php.

Referenced by __construct().

$errorStack

array ilSamlIdpXmlMetadataParser::$errorStack = []

private

Definition at line 31 of file class.ilSamlIdpXmlMetadataParser.php.

$result

Result ilSamlIdpXmlMetadataParser::$result

private

Definition at line 28 of file class.ilSamlIdpXmlMetadataParser.php.

Referenced by result().

$xmlErrorState

bool ilSamlIdpXmlMetadataParser::$xmlErrorState = false

private

Definition at line 29 of file class.ilSamlIdpXmlMetadataParser.php.

---

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

• Services/Saml/classes/class.ilSamlIdpXmlMetadataParser.php