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

Inheritance diagram for ilDataSetImportParser:

Collaboration diagram for ilDataSetImportParser:

Public Member Functions
	__construct ($a_top_entity, $a_schema_version, $a_xml, $a_ds, $a_mapping)
	Constructor. More...

	getCurrentInstallationId ()
	Get current installation id. More...

	setHandlers ($a_xml_parser)
	Set event handlers. More...

	startParsing ()
	Start parser. More...

	handleBeginTag ($a_xml_parser, $a_name, $a_attribs)
	Begin Tag. More...

	handleEndTag ($a_xml_parser, $a_name)
	End Tag. More...

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

Public Member Functions inherited from ilSaxParser
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object public. More...

	setXMLContent ($a_xml_content)

	getXMLContent ()

	getInputType ()

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

	createParser ()
	create parser More...

	setOptions ($a_xml_parser)
	set parser options More...

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...

	openXMLFile ()
	open xml file More...

	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...

	freeParser ($a_xml_parser)
	free xml parser handle More...

	setThrowException ($throwException)
	set error handling More...

Public Member Functions inherited from PEAR
	__construct ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Protected Attributes
	$import = null

	$entities = array()

	$current_entity = ""

	$current_version = ""

	$current_ftypes = array()

	$entities_sent = false

	$in_record = false

	$current_field = ""

	$current_field_values = array()

	$current_installation_id = ""

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static &	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

Data Fields inherited from ilSaxParser
	$input_type = null

	$xml_content = ''

	$ilias

	$lng

	$xml_file

	$throwException = false

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Detailed Description

Manifest parser for ILIAS standard export files.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

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

References ilSaxParser\setXMLContent(), and 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 ( )

Get current installation id.

Parameters

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

References $current_installation_id.

     {
         return $this->current_installation_id;
     }

◆ handleBeginTag()

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

Begin Tag.

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

References array.

     {
         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,
		$a_data
	)

End Tag.

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

     {
         //$a_data = str_replace("<","&lt;",$a_data);
         //$a_data = str_replace(">","&gt;",$a_data);
         // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
         //$a_data = preg_replace("/\n/","",$a_data);
         //$a_data = preg_replace("/\t+/","",$a_data);
 
         $this->chr_data .= $a_data;
     }

◆ handleEndTag()

ilDataSetImportParser::handleEndTag	(	$a_xml_parser,
		$a_name
	)

End Tag.

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

References $current_entity, $current_field, and array.

     {
         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 )

Set event handlers.

Parameters

resource reference to the xml parser private

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

     {
         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()

ilDataSetImportParser::startParsing ( )

Start parser.

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

Referenced by __construct().

     {
         parent::startParsing();
     }

Here is the caller graph for this function:

Field Documentation

◆ $current_entity

ilDataSetImportParser::$current_entity = ""

protected

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

Referenced by handleEndTag().

◆ $current_field

ilDataSetImportParser::$current_field = ""

protected

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

Referenced by handleEndTag().

◆ $current_field_values

ilDataSetImportParser::$current_field_values = array()

protected

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

◆ $current_ftypes

ilDataSetImportParser::$current_ftypes = array()

protected

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

◆ $current_installation_id

ilDataSetImportParser::$current_installation_id = ""

protected

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

Referenced by getCurrentInstallationId().

◆ $current_version

ilDataSetImportParser::$current_version = ""

protected

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

◆ $entities

ilDataSetImportParser::$entities = array()

protected

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

◆ $entities_sent

ilDataSetImportParser::$entities_sent = false

protected

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

◆ $import

ilDataSetImportParser::$import = null

protected

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

◆ $in_record

ilDataSetImportParser::$in_record = false

protected

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

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

Services/DataSet/classes/class.ilDataSetImportParser.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCurrentInstallationId()

◆ handleBeginTag()

◆ handleCharacterData()

◆ handleEndTag()

◆ setHandlers()

◆ startParsing()

Field Documentation

◆ $current_entity

◆ $current_field

◆ $current_field_values

◆ $current_ftypes

◆ $current_installation_id

◆ $current_version

◆ $entities

◆ $entities_sent

◆ $import

◆ $in_record