Inheritance diagram for ilAdvancedMDParser:

Collaboration diagram for ilAdvancedMDParser:

Public Member Functions
	__construct ($a_obj_id, $a_mapping)

	setHandlers ($a_xml_parser)

	createLocalRecord ($a_old_id, $a_xml, $a_obj_id, $a_sub_type=null)

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	Start element handler. More...

	handlerEndTag ($a_xml_parser, $a_name)
	End element handler. More...

	handlerCharacterData ($a_xml_parser, $a_data)
	Character data handler. More...

	getRecordIds ()

Public Member Functions inherited from ilMDSaxParser
	__construct ($a_xml_file='')
	Constructor. More...

	enableMDParsing ($a_status)

	getMDParsingStatus ()

	setMDObject (&$md)

&	getMDObject ()

	inMetaData ()

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

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	handler for begin of element More...

	handlerEndTag ($a_xml_parser, $a_name)
	handler for end of element More...

	handlerCharacterData ($a_xml_parser, $a_data)
	handler for character data More...

	__getCharacterData ()

	__pushParent (&$md_obj)

&	__popParent ()

&	__getParent ()

	__construct ($a_xml_file='')
	Constructor. More...

	setMDObject (&$md)

	inMetaData ()

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	handler for begin of element More...

	handlerEndTag ($a_xml_parser, $a_name)
	handler for end of element More...

	handlerCharacterData ($a_xml_parser, $a_data)
	handler for character data More...

	__getCharacterData ()

	__pushParent (&$md_obj)

&	__popParent ()

&	__getParent ()

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 Member Functions
	initValue ($a_import_id, $a_sub_type="", $a_sub_id=0, $a_local_rec_id=null)

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

Protected Attributes
	$obj_id

	$rec_id

	$mapping

	$cdata

	$value_records = array()

	$current_record

	$current_value

	$has_values

	$record_ids = array()

	$local_record

	$local_rec_map = array()

	$local_rec_fields_map = array()

	$log

Protected Attributes inherited from ilMDSaxParser
	$meta_log

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 ilMDSaxParser
	$md_in_md = false

	$md_chr_data = ''

	$md_cur_el = null

	$md_parsing_enabled = null

	$md = null

	$md_gen

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

Detailed Description

Adv MD XML Parser.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id: class.ilCourseXMLParser.php 53320 2014-09-12 11:33:49Z fwolf

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDParser::__construct	(	$a_obj_id,
		$a_mapping
	)

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

References ilLoggerFactory\getLogger().

     {
         parent::__construct();
 
         $this->log = ilLoggerFactory::getLogger('amet');
 
         $parts = explode(":", $a_obj_id);
         $this->obj_id = $parts[0];
         $this->mapping = $a_mapping;
     }

Here is the call graph for this function:

Member Function Documentation

◆ createLocalRecord()

ilAdvancedMDParser::createLocalRecord	(	$a_old_id,
		$a_xml,
		$a_obj_id,
		$a_sub_type = `null`
	)

Definition at line 58 of file class.ilAdvancedMDParser.php.

References $parser, ilObject\_lookupType(), ilUtil\ilTempnam(), ilAdvancedMDRecordParser\MODE_INSERT, and ilAdvancedMDRecordParser\MODE_INSERT_VALIDATION.

Referenced by initValue().

     {
         $tmp_file = ilUtil::ilTempnam();
         file_put_contents($tmp_file, $a_xml);
         
         // see ilAdvancedMDSettingsGUI::importRecord()
         try {
             // the (old) record parser does only support files
             include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordParser.php');
             $parser = new ilAdvancedMDRecordParser($tmp_file);
             $parser->setContext($a_obj_id, ilObject::_lookupType($a_obj_id), $a_sub_type);
             $parser->setMode(ilAdvancedMDRecordParser::MODE_INSERT_VALIDATION);
             $parser->startParsing();
             $parser->setMode(ilAdvancedMDRecordParser::MODE_INSERT);
             $parser->startParsing();
         } catch (ilSAXParserException $exc) {
         }
                 
         unlink($tmp_file);
             
         $map = $parser->getRecordMap();
         foreach ($map as $record_id => $fields) {
             $this->local_rec_fields_map[$record_id] = $fields;
             
             // needed for glossary field order
             foreach ($fields as $import_id => $new_id) {
                 $old_id = array_pop(explode("_", $import_id));
                 $this->mapping->addMapping("Services/AdvancedMetaData", "lfld", $old_id, $new_id);
             }
         }
         
         $new_id = array_shift(array_keys($map));
         $this->local_rec_map[$a_old_id] = $new_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordIds()

ilAdvancedMDParser::getRecordIds ( )

Definition at line 240 of file class.ilAdvancedMDParser.php.

References $record_ids.

     {
         return $this->record_ids;
     }

◆ handlerBeginTag()

ilAdvancedMDParser::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

Start element handler.

public

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name
array	$a_attribs	element attributes array

Implements ilSaxSubsetParser.

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

References array, and initValue().

     {
         switch ($a_name) {
             case 'AdvancedMetaData':
                 break;
             
             case 'Record':
                 $this->local_record = array('id'=>$a_attribs['local_id']);
                 break;
                 
             case 'Value':
                 $this->initValue($a_attribs['id'], $a_attribs['sub_type'], $a_attribs['sub_id'], $a_attribs['local_rec_id']);
                 break;
         }
     }

Here is the call graph for this function:

◆ handlerCharacterData()

ilAdvancedMDParser::handlerCharacterData	(	$a_xml_parser,
		$a_name
	)

Character data handler.

public

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

Implements ilSaxSubsetParser.

Definition at line 135 of file class.ilAdvancedMDParser.php.

     {
         if ($a_data != "\n") {
             // Replace multiple tabs with one space
             $a_data = preg_replace("/\t+/", " ", $a_data);
 
             $this->cdata .= $a_data;
         }
     }

◆ handlerEndTag()

ilAdvancedMDParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

End element handler.

public

Parameters

resource	$a_xml_parser	xml parser
string	$a_name	element name

Implements ilSaxSubsetParser.

Definition at line 109 of file class.ilAdvancedMDParser.php.

     {
         switch ($a_name) {
             case 'AdvancedMetaData':
                 // we need to write all records that have been created (1 for each sub-item)
                 foreach ($this->value_records as $record) {
                     $record->write();
                 }
                 break;
                 
             case 'Record':
                 $this->local_record['xml'] = base64_decode(trim($this->cdata));
                 $this->log->debug("Local Record XML: " . $this->local_record['xml']);
                 break;
                 
             case 'Value':
                 $value = trim($this->cdata);
                 $this->log->debug("End Tag Value: -" . is_object($this->current_value) . "-" . $value);
                 if (is_object($this->current_value) && $value != "") {
                     $this->current_value->importValueFromXML($value);
                 }
                 break;
         }
         $this->cdata = '';
     }

◆ initValue()

ilAdvancedMDParser::initValue	(	$a_import_id,
		$a_sub_type = `""`,
		$a_sub_id = `0`,
		$a_local_rec_id = `null`
	)

protected

Definition at line 145 of file class.ilAdvancedMDParser.php.

References $def, $rec_id, createLocalRecord(), and ilAdvancedMDFieldDefinition\getInstanceByImportId().

Referenced by handlerBeginTag().

     {
         $this->current_value = null;
                 
         // get parent objects
         $new_parent_id = $this->mapping->getMapping("Services/AdvancedMetaData", "parent", $this->obj_id);
         $this->log->notice('Found new parent id:' . $new_parent_id);
         if (!$new_parent_id) {
             return;
         }
         if (
             $a_sub_type &&
             strcmp($a_sub_type, '-') !== 0
         ) {
             $new_sub_id = $this->mapping->getMapping("Services/AdvancedMetaData", "advmd_sub_item", "advmd:" . $a_sub_type . ":" . $a_sub_id);
             if (!$new_sub_id) {
                 return;
             }
         }
                 
         // init local record?
         // done here because we need object context
         if (is_array($this->local_record)) {
             $this->createLocalRecord($this->local_record['id'], $this->local_record['xml'], $new_parent_id, $a_sub_type);
             $this->local_record = null;
         }
                 
         $rec_id = null;
         
         // find record via import id
         if (!$a_local_rec_id) {
             if ($field = ilAdvancedMDFieldDefinition::getInstanceByImportId($a_import_id)) {
                 $rec_id = $field->getRecordId();
             }
         }
         // (new) local record
         else {
             $rec_id = $this->local_rec_map[$a_local_rec_id];
         }
         
         if (!$rec_id) {
             return;
         }
                     
         // init record definitions
         if ($a_sub_type) {
             $rec_idx = $rec_id . ";" . $a_sub_type . ";" . $new_sub_id;
             if (!array_key_exists($rec_idx, $this->value_records)) {
                 $this->value_records[$rec_idx] = new ilAdvancedMDValues($rec_id, $new_parent_id, $a_sub_type, $new_sub_id);
             }
         } else {
             $rec_idx = $rec_id . ";;";
             if (!array_key_exists($rec_idx, $this->value_records)) {
                 $this->value_records[$rec_idx] = new ilAdvancedMDValues($rec_id, $new_parent_id);
             }
         }
 
         // init ADTGroup before definitions to bind definitions to group
         $this->value_records[$rec_idx]->getADTGroup();
 
         // find element with import id
         $this->log->debug("Find element: " . $a_import_id . ", local rec_id: " . $a_local_rec_id);
         if (!$a_local_rec_id) {
             foreach ($this->value_records[$rec_idx]->getDefinitions() as $def) {
                 if ($a_import_id == $def->getImportId()) {
                     $this->current_value = $def;
                     break;
                 }
             }
         } else {
             // find element in new local record
             $field_id = $this->local_rec_fields_map[$rec_id][$a_import_id];
             if ($field_id) {
                 $this->log->debug("- Field id: " . $field_id);
                 foreach ($this->value_records[$rec_idx]->getDefinitions() as $def) {
                     $this->log->debug("- Def field id: " . $def->getFieldId());
                     if ($field_id == $def->getFieldId()) {
                         $this->current_value = $def;
                         break;
                     }
                 }
             } else {
                 $this->log->debug("- No Field id. local rec: " . $a_local_rec_id .
                     ", rec id:" . $rec_id . ", import id: " . $a_import_id . ", map: " . print_r($this->local_rec_fields_map, true));
             }
         }
         
         // record will be selected for parent
         // see ilAdvancedMetaDataImporter
         if ($this->current_value &&
             !$a_local_rec_id) {
             $this->record_ids[$new_parent_id][$a_sub_type][] = $rec_id;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilAdvancedMDParser::setHandlers ( $a_xml_parser )

Definition at line 51 of file class.ilAdvancedMDParser.php.

     {
         $this->sax_controller = new ilSaxController();
         $this->sax_controller->setHandlers($a_xml_parser);
         $this->sax_controller->setDefaultElementHandler($this);
     }