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.

33 {

34 }

Member Function Documentation

◆ addErrors()

ilSamlIdpXmlMetadataParser::addErrors ( )

private

Definition at line 48 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 36 of file class.ilSamlIdpXmlMetadataParser.php.

                                   : void
    {
        if ([] === $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 60 of file class.ilSamlIdpXmlMetadataParser.php.

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

References addErrors().

Referenced by ok().

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.

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

References ILIAS\Data\Result\error().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ok()

ilSamlIdpXmlMetadataParser::ok ( string $entity_id )

private

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

                                          : Result
    {
        $this->endLogging();
 
        return $this->dataFactory->ok($entity_id);
    }

References endLogging().

Referenced by parse().

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.

                                            : 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();
        }
    }