Export file parser. More...

Inheritance diagram for ilExportFileParser:

Collaboration diagram for ilExportFileParser:

Public Member Functions
	__construct (string $a_file, object $a_callback_obj, string $a_callback_func)
	ilExportFileParser constructor. More...

	setHandlers ($a_xml_parser)
	@inheritDoc More...

	startParsing ()
	@inheritDoc More...

	handleBeginTag ($a_xml_parser, string $a_name, array $a_attribs)

	handleEndTag ($a_xml_parser, string $a_name)

	handleCharacterData ($a_xml_parser, string $a_data)
	End Tag. More...

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

Protected Attributes
string	$item_xml = ""

bool	$in_export_item = false

string	$chr_data = ""

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Attributes
string	$entity = ''

string	$install_id = ''

string	$install_url = ''

string	$schema_version = ''

array	$expfiles = []

string	$current_id = ''

object	$callback_obj

string	$callback_func

ilXmlWriter	$export_item_writer = null

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Detailed Description

Export file parser.

Author: Aleex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 22 of file class.ilExportFileParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilExportFileParser::__construct	(	string	$a_file,
		object	$a_callback_obj,
		string	$a_callback_func
	)

ilExportFileParser constructor.

@inheritDoc

Definition at line 43 of file class.ilExportFileParser.php.

    {
        $this->callback_obj = $a_callback_obj;
        $this->callback_func = $a_callback_func;
 
        parent::__construct($a_file, true);
        $this->startParsing();
    }

References ILIAS\GlobalScreen\Provider\__construct(), and startParsing().

Here is the call graph for this function:

Member Function Documentation

◆ handleBeginTag()

ilExportFileParser::handleBeginTag	(		$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

Definition at line 70 of file class.ilExportFileParser.php.

                                                                                   : void
    {
        if ($this->in_export_item) {
            $this->export_item_writer->xmlStartTag($a_name, $a_attribs);
        }
 
        switch ($a_name) {
            case "exp:Export":
                $this->entity = $a_attribs["Entity"];
                $this->install_id = $a_attribs["InstallationId"];
                $this->install_url = $a_attribs["InstallationUrl"];
                $this->schema_version = $a_attribs["SchemaVersion"];
                break;
 
            case "exp:ExportItem":
                $this->in_export_item = true;
                $this->current_id = $a_attribs["Id"];
                $this->export_item_writer = new ilXmlWriter();
                $this->item_xml = "";
                $this->expfiles[] = array(
                    "component" => $a_attribs["Component"] ?? null,
                    "path" => $a_attribs["Path"] ?? null
                );
                break;
        }
    }

◆ handleCharacterData()

ilExportFileParser::handleCharacterData	(		$a_xml_parser,
		string	$a_data
	)

End Tag.

Definition at line 125 of file class.ilExportFileParser.php.

                                                                      : void
    {
        $this->chr_data .= $a_data;
        if ($this->in_export_item) {
            $this->export_item_writer->xmlData($a_data);
        }
    }

◆ handleEndTag()

ilExportFileParser::handleEndTag	(		$a_xml_parser,
		string	$a_name
	)

Definition at line 97 of file class.ilExportFileParser.php.

                                                               : void
    {
        switch ($a_name) {
            case "exp:ExportItem":
                $this->in_export_item = false;
                $cf = $this->callback_func;
                $this->callback_obj->$cf(
                    $this->entity,
                    $this->schema_version,
                    $this->current_id,
                    $this->export_item_writer->xmlDumpMem(false),
                    $this->install_id,
                    $this->install_url
                );
                break;
 
        }
 
        if ($this->in_export_item) {
            $this->export_item_writer->xmlEndTag($a_name);
        }
 
        $this->chr_data = "";
    }

References $callback_func.

◆ setHandlers()

ilExportFileParser::setHandlers ( $a_xml_parser )

@inheritDoc

Reimplemented from ilSaxParser.

Definition at line 55 of file class.ilExportFileParser.php.

                                              : void
    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handleBeginTag', 'handleEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handleCharacterData');
    }

◆ startParsing()

ilExportFileParser::startParsing ( )

@inheritDoc

Reimplemented from ilSaxParser.

Definition at line 65 of file class.ilExportFileParser.php.

                                  : void
    {
        parent::startParsing();
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $callback_func

string ilExportFileParser::$callback_func

private

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

Referenced by handleEndTag().

◆ $callback_obj

object ilExportFileParser::$callback_obj

private

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

◆ $chr_data

string ilExportFileParser::$chr_data = ""

protected

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

◆ $current_id

string ilExportFileParser::$current_id = ''

private

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

◆ $entity

string ilExportFileParser::$entity = ''

private

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

◆ $expfiles

array ilExportFileParser::$expfiles = []

private

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

◆ $export_item_writer

ilXmlWriter ilExportFileParser::$export_item_writer = null

private

Definition at line 37 of file class.ilExportFileParser.php.

◆ $in_export_item

bool ilExportFileParser::$in_export_item = false

protected

Definition at line 32 of file class.ilExportFileParser.php.

◆ $install_id

string ilExportFileParser::$install_id = ''

private

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

◆ $install_url

string ilExportFileParser::$install_url = ''

private

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

◆ $item_xml

string ilExportFileParser::$item_xml = ""

protected

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

◆ $schema_version

string ilExportFileParser::$schema_version = ''

private

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

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

Services/Export/classes/class.ilExportFileParser.php

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ handleBeginTag()

◆ handleCharacterData()

◆ handleEndTag()

◆ setHandlers()

◆ startParsing()

Field Documentation

◆ $callback_func

◆ $callback_obj

◆ $chr_data

◆ $current_id

◆ $entity

◆ $expfiles

◆ $export_item_writer

◆ $in_export_item

◆ $install_id

◆ $install_url

◆ $item_xml

◆ $schema_version