Manifest parser for ILIAS standard export files. More...

Inheritance diagram for ilDataSetImportParser:

Collaboration diagram for ilDataSetImportParser:

Public Member Functions
	__construct (string $a_top_entity, string $a_schema_version, string $a_xml, ilDataSet $a_ds, ilImportMapping $a_mapping)

	getCurrentInstallationId ()

	setHandlers ($a_xml_parser)

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

	handleEndTag ( $a_xml_parser, string $a_name)

	handleCharacterData ( $a_xml_parser, string $a_data)

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	$dspref

string	$schema_version

string	$top_entity

ilDataSet	$ds

ilImport	$import = null

array	$entities = array()

string	$current_entity = ""

string	$current_version = ""

array	$current_ftypes = array()

bool	$entities_sent = false

bool	$in_record = false

string	$current_field = ""

array	$current_field_values = array()

string	$current_installation_id = ""

string	$chr_data = ""

ilImportMapping	$mapping

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = 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

Manifest parser for ILIAS standard export files.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 21 of file class.ilDataSetImportParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilDataSetImportParser::__construct	(	string	$a_top_entity,
		string	$a_schema_version,
		string	$a_xml,
		ilDataSet	$a_ds,
		ilImportMapping	$a_mapping
	)

Definition at line 40 of file class.ilDataSetImportParser.php.

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

       {
         $this->ds = $a_ds;
         $this->mapping = $a_mapping;
         $this->top_entity = $a_top_entity;
         $this->schema_version = $a_schema_version;
         $this->dspref = ($this->ds->getDSPrefix() !== "")
             ? $this->ds->getDSPrefix() . ":"
             : "";
 
         parent::__construct();
         $this->setXMLContent($a_xml);
         $this->startParsing();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getCurrentInstallationId()

ilDataSetImportParser::getCurrentInstallationId ( )

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

References $current_installation_id.

                                               : string
     {
         return $this->current_installation_id;
     }

◆ handleBeginTag()

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

Definition at line 74 of file class.ilDataSetImportParser.php.

      : void {
         switch ($a_name) {
             case $this->dspref . "DataSet":
 //                              $this->import->initDataset($this->ds_component, $a_attribs["top_entity"]);
                 $this->current_installation_id = $a_attribs["InstallationId"];
                 $this->ds->setCurrentInstallationId($a_attribs["InstallationId"]);
                 break;
 
             case $this->dspref . "Types":
                 $this->current_entity = $a_attribs["Entity"];
                 $this->current_version = $a_attribs["Version"];
                 break;
 
             case $this->dspref . "FieldType":
                 $this->current_ftypes[$a_attribs["Name"]] =
                     $a_attribs["Type"];
                 break;
 
             case $this->dspref . "Rec":
                 $this->current_entity = $a_attribs["Entity"];
                 $this->in_record = true;
                 $this->current_field_values = array();
                 break;
 
             default:
                 if ($this->in_record) {
                     $field = explode(":", $a_name);             // remove namespace
                     $field = $field[count($field) - 1];
                     $this->current_field = $field;
                 }
         }
     }

◆ handleCharacterData()

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

Definition at line 153 of file class.ilDataSetImportParser.php.

      : void {
         $this->chr_data .= $a_data;
     }

◆ handleEndTag()

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

Definition at line 111 of file class.ilDataSetImportParser.php.

References $chr_data, $current_entity, and $current_field.

      : void {
         switch ($a_name) {
             case $this->dspref . "Types":
                 $this->entities[$this->current_entity] =
                     array(
                         "version" => $this->current_version,
                         "types" => $this->current_ftypes
                         );
                 $this->current_ftypes = array();
                 $this->current_entity = "";
                 $this->current_version = "";
                 break;
 
             case $this->dspref . "Rec":
                 $this->ds->importRecord(
                     $this->current_entity,
                     $this->entities[$this->current_entity]["types"] ?? [],
                     $this->current_field_values,
                     $this->mapping,
                     $this->schema_version
                 );
                 $this->in_record = false;
                 $this->current_entity = "";
                 $this->current_field_values = array();
                 break;
 
             default:
                 if ($this->in_record && $this->current_field !== "") {
                     $this->current_field_values[$this->current_field] =
                         $this->chr_data;
                 }
                 $this->current_field = "";
                 break;
         }
 
         $this->chr_data = "";
     }

◆ setHandlers()

ilDataSetImportParser::setHandlers ( $a_xml_parser )

Definition at line 66 of file class.ilDataSetImportParser.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');
     }