ilScormImportParser Class Reference

Collaboration diagram for ilScormImportParser:

Public Member Functions
	__construct (DataTypeFactory $data_factory)
	parse (string $xmlString)

Private Member Functions
	formatError (LibXMLError $error)
	formatErrors (LibXMLError ... $errors)
	beginLogging ()
	addErrors ()
	endLogging ()

Private Attributes
bool	$xml_error_state = false
array	$error_stack = []
DataTypeFactory	$df

Detailed Description

Definition at line 23 of file class.ilScormImportParser.php.

Constructor & Destructor Documentation

__construct()

ilScormImportParser::__construct

(

DataTypeFactory

$data_factory

)

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

    {
        $this->df = $data_factory;
    }

Member Function Documentation

addErrors()

ilScormImportParser::addErrors ( )

private

Definition at line 68 of file class.ilScormImportParser.php.

Referenced by beginLogging(), and endLogging().

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

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

Here is the caller graph for this function:

beginLogging()

ilScormImportParser::beginLogging ( )

private

Definition at line 56 of file class.ilScormImportParser.php.

References addErrors().

Referenced by parse().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

endLogging()

ilScormImportParser::endLogging ( )

private

Returns

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

Definition at line 80 of file class.ilScormImportParser.php.

References $errors, and addErrors().

Referenced by parse().

                                 : array
    {
        $this->addErrors();

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

        if ([] === $this->error_stack) {
            libxml_use_internal_errors($this->xml_error_state);
        }

        return $errors;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

formatError()

ilScormImportParser::formatError ( LibXMLError  $error )

private

Definition at line 35 of file class.ilScormImportParser.php.

Referenced by formatErrors().

                                                    : string
    {
        return implode(',', [
            'level=' . $error->level,
            'code=' . $error->code,
            'line=' . $error->line,
            'col=' . $error->column,
            'msg=' . trim($error->message)
        ]);
    }

Here is the caller graph for this function:

formatErrors()

ilScormImportParser::formatErrors ( LibXMLError ...  $errors )

private

Definition at line 46 of file class.ilScormImportParser.php.

References formatError().

Referenced by parse().

                                                         : string
    {
        $text = '';
        foreach ($errors as $error) {
            $text .= $this->formatError($error) . "\n";
        }

        return $text;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parse()

ilScormImportParser::parse

(

string

$xmlString

)

Definition at line 93 of file class.ilScormImportParser.php.

References Vendor\Package\$e, $errors, $xml, beginLogging(), endLogging(), and formatErrors().

                                            : \ILIAS\Data\Result
    {
        try {
            $this->beginLogging();

            $xml = new SimpleXMLElement($xmlString);

            $errors = $this->endLogging();

            if ($xml->xpath('//SubType')) {
                return $this->df->ok($xml);
            }

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

            $errors[] = $error;

            return $this->df->error($this->formatErrors(...$errors));
        } catch (Throwable $e) {
            return $this->df->error($this->formatErrors(...$this->endLogging()));
        }
    }

Here is the call graph for this function:

Field Documentation

$df

DataTypeFactory ilScormImportParser::$df

private

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

$error_stack

array ilScormImportParser::$error_stack = []

private

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

$xml_error_state

bool ilScormImportParser::$xml_error_state = false

private

Definition at line 25 of file class.ilScormImportParser.php.

---

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

• Modules/ScormAicc/classes/class.ilScormImportParser.php