ilXMLChecker Class Reference

Collaboration diagram for ilXMLChecker:

Public Member Functions
	__construct (private readonly DataTypeFactory $dataFactory)
	parse (string $xmlString)
	result ()

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

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

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilXMLChecker::__construct

(

private readonly DataTypeFactory

$dataFactory

)

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

References result().

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

Here is the call graph for this function:

Member Function Documentation

addErrors()

ilXMLChecker::addErrors ( )

private

Definition at line 48 of file class.ilXmlChecker.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()

ilXMLChecker::beginLogging ( )

private

Definition at line 36 of file class.ilXmlChecker.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()

ilXMLChecker::endLogging ( )

private

Returns

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

Definition at line 60 of file class.ilXmlChecker.php.

References addErrors().

Referenced by parse().

                                 : 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:

parse()

ilXMLChecker::parse

(

string

$xmlString

)

PhpExpressionResultUnusedInspection

Definition at line 73 of file class.ilXmlChecker.php.

References beginLogging(), endLogging(), and result().

                                            : void
    {
        try {
            $this->beginLogging();

            new SimpleXMLElement($xmlString);

            $this->result = $this->dataFactory->ok($xmlString);
            $this->endLogging();
        } catch (Exception) {
            $this->result = $this->dataFactory->error(implode(
                "\n",
                array_map(static function (LibXMLError $error): string {
                    return implode(',', [
                        'level=' . $error->level,
                        'code=' . $error->code,
                        'line=' . $error->line,
                        'col=' . $error->column,
                        'msg=' . trim($error->message)
                    ]);
                }, $this->endLogging())
            ));
        }
    }

Here is the call graph for this function:

result()

ilXMLChecker::result

(

)

Definition at line 99 of file class.ilXmlChecker.php.

References $result.

Referenced by __construct(), and parse().

                            : Result
    {
        return $this->result;
    }

Here is the caller graph for this function:

Field Documentation

$errorStack

array ilXMLChecker::$errorStack = []

private

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

$result

Result ilXMLChecker::$result

private

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

Referenced by result().

$xmlErrorState

bool ilXMLChecker::$xmlErrorState = false

private

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

---

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

• components/ILIAS/Certificate/classes/File/Template/XLS/class.ilXmlChecker.php