ilSamlIdpXmlMetadataParser Class Reference

Collaboration diagram for ilSamlIdpXmlMetadataParser:

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

Private Member Functions
	beginLogging ()
	addErrors ()
	endLogging ()
	ok (string $entity_id)
	error ($additional_errors=[])

Private Attributes
bool	$xmlErrorState = false
array	$errorStack = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

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

      {
    }

Member Function Documentation

addErrors()

ilSamlIdpXmlMetadataParser::addErrors ( )

private

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

Referenced by beginLogging(), and endLogging().

                                : void
    {
        $currentErrors = libxml_get_errors();
        libxml_clear_errors();

        $level = count($this->errorStack) - 1;
        $this->errorStack[$level] = array_merge($this->errorStack[$level], $currentErrors);
    }

Here is the caller graph for this function:

beginLogging()

ilSamlIdpXmlMetadataParser::beginLogging ( )

private

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

References addErrors().

Referenced by parse().

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

        $this->errorStack[] = [];
    }

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 60 of file class.ilSamlIdpXmlMetadataParser.php.

References addErrors().

Referenced by ok().

                                 : array
    {
        $this->addErrors();

        $errors = array_pop($this->errorStack);

        if ([] === $this->errorStack) {
            libxml_use_internal_errors($this->xmlErrorState);
        }

        return $errors;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

error()

ilSamlIdpXmlMetadataParser::error (   $additional_errors = [] )

private

Parameters

list<LibXMLError>

$additional_errors

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

Referenced by parse().

                                                   : Result
    {
        return $this->dataFactory->error($this->errorFormatter->formatErrors(...$this->endLogging(), ...$additional_errors));
    }

Here is the caller graph for this function:

ok()

ilSamlIdpXmlMetadataParser::ok ( string  $entity_id )

private

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

References endLogging().

Referenced by parse().

                                          : Result
    {
        $this->endLogging();

        return $this->dataFactory->ok($entity_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parse()

ilSamlIdpXmlMetadataParser::parse

(

string

$xmlString

)

Returns

Result<non-empty-string>

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

References beginLogging(), error(), and ok().

                                            : Result
    {
        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]');

            $entity_id = ($idps[0] ?? null)?->attributes('', true)['entityID'][0] ?? '';
            $entity_id = (string) $entity_id;

            if ($entity_id !== '') {
                return $this->ok($entity_id);
            }

            $error = new LibXMLError();
            $error->level = LIBXML_ERR_FATAL;
            $error->code = 0;
            $error->message = 'No entityID found';
            $error->line = 1;
            $error->column = 0;

            return $this->error([$error]);
        } catch (Exception) {
            return $this->error();
        }
    }

Here is the call graph for this function:

Field Documentation

$errorStack

array ilSamlIdpXmlMetadataParser::$errorStack = []

private

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

$xmlErrorState

bool ilSamlIdpXmlMetadataParser::$xmlErrorState = false

private

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

---

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

• components/ILIAS/Saml/classes/class.ilSamlIdpXmlMetadataParser.php