ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilDataSetImportParser Class Reference

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
 ilSaxParser ($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
 PEAR ($error_class=null)
 Constructor. More...
 
 _PEAR ()
 Destructor (the emulated type of...). More...
 
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...
 
 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...
 
 setErrorHandling ($mode=null, $options=null)
 Sets how errors generated by this object should be handled. 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

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

34  {
35  $this->ds = $a_ds;
36  $this->mapping = $a_mapping;
37  $this->top_entity = $a_top_entity;
38  $this->schema_version = $a_schema_version;
39  $this->dspref = ($this->ds->getDSPrefix() != "")
40  ? $this->ds->getDSPrefix().":"
41  : "";
42 
43  parent::ilSaxParser();
44  $this->setXMLContent($a_xml);
45  $this->startParsing();
46 
47 
48  }
setXMLContent($a_xml_content)
+ Here is the call graph for this function:

Member Function Documentation

◆ getCurrentInstallationId()

ilDataSetImportParser::getCurrentInstallationId ( )

Get current installation id.

Parameters

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

References $current_installation_id.

◆ handleBeginTag()

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

Begin Tag.

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

88  {
89  switch ($a_name)
90  {
91  case $this->dspref."DataSet":
92 // $this->import->initDataset($this->ds_component, $a_attribs["top_entity"]);
93  $this->current_installation_id = $a_attribs["InstallationId"];
94  $this->ds->setCurrentInstallationId($a_attribs["InstallationId"]);
95  break;
96 
97  case $this->dspref."Types":
98  $this->current_entity = $a_attribs["Entity"];
99  $this->current_version = $a_attribs["Version"];
100  break;
101 
102  case $this->dspref."FieldType":
103  $this->current_ftypes[$a_attribs["Name"]] =
104  $a_attribs["Type"];
105  break;
106 
107  case $this->dspref."Rec":
108  $this->current_entity = $a_attribs["Entity"];
109  $this->in_record = true;
110  $this->current_field_values = array();
111  break;
112 
113  default:
114  if ($this->in_record)
115  {
116  $field = explode(":", $a_name); // remove namespace
117  $field = $field[count($field) - 1];
118  $this->current_field = $field;
119  }
120  }
121  }

◆ handleCharacterData()

ilDataSetImportParser::handleCharacterData (   $a_xml_parser,
  $a_data 
)

End Tag.

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

169  {
170  //$a_data = str_replace("<","&lt;",$a_data);
171  //$a_data = str_replace(">","&gt;",$a_data);
172  // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
173  //$a_data = preg_replace("/\n/","",$a_data);
174  //$a_data = preg_replace("/\t+/","",$a_data);
175 
176  $this->chr_data .= $a_data;
177  }

◆ handleEndTag()

ilDataSetImportParser::handleEndTag (   $a_xml_parser,
  $a_name 
)

End Tag.

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

References $current_entity, and $current_field.

127  {
128  switch ($a_name)
129  {
130  case $this->dspref."Types":
131  $this->entities[$this->current_entity] =
132  array(
133  "version" => $this->current_version,
134  "types" => $this->current_ftypes
135  );
136  $this->current_ftypes = array();
137  $this->current_entity = "";
138  $this->current_version = "";
139  break;
140 
141  case $this->dspref."Rec":
142  $this->ds->importRecord($this->current_entity,
143  $this->entities[$this->current_entity]["types"],
144  $this->current_field_values,
145  $this->mapping,
146  $this->schema_version);
147  $this->in_record = false;
148  $this->current_entity = "";
149  $this->current_field_values = array();
150  break;
151 
152  default:
153  if ($this->in_record && $this->current_field != "")
154  {
155  $this->current_field_values[$this->current_field] =
156  $this->chr_data;
157  }
158  $this->current_field = "";
159  break;
160  }
161 
162  $this->chr_data = "";
163  }

◆ setHandlers()

ilDataSetImportParser::setHandlers (   $a_xml_parser)

Set event handlers.

Parameters
resourcereference to the xml parser private

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

69  {
70  xml_set_object($a_xml_parser,$this);
71  xml_set_element_handler($a_xml_parser, 'handleBeginTag', 'handleEndTag');
72  xml_set_character_data_handler($a_xml_parser, 'handleCharacterData');
73  }

◆ startParsing()

ilDataSetImportParser::startParsing ( )

Start parser.

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

Referenced by __construct().

80  {
81  parent::startParsing();
82  }
+ 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: