Adv MD XML Parser. More...

Inheritance diagram for ilAdvancedMDParser:

Collaboration diagram for ilAdvancedMDParser:

Public Member Functions
	__construct (string $a_obj_id, ilImportMapping $a_mapping)

	setHandlers ($a_xml_parser)

	createLocalRecord (int $a_old_id, string $a_xml, int $a_obj_id, ?string $a_sub_type=null)

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

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

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

	getRecordIds ()

Public Member Functions inherited from ilMDSaxParser
	__construct (?string $a_xml_file='')

	enableMDParsing (bool $a_status)

	getMDParsingStatus ()

	setMDObject (ilMD $md)

	getMDObject ()

	inMetaData ()

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

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

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)

	__getCharacterData ()

	__pushParent (object $md_obj)

	__popParent ()

	__getParent ()

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

Protected Member Functions inherited from ilMDSaxParser
	trimAndStripAttribs (array $attribs)

	trimAndStrip (string $input)

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes
int	$obj_id

int	$rec_id = 0

ilImportMapping	$mapping

string	$cdata = ""

ilSaxController	$sax_controller = null

array	$value_records = []

ilAdvancedMDFieldDefinition	$current_value = null

array	$record_ids = []

array	$local_record = null

array	$local_rec_map = []

array	$local_rec_fields_map = []

ilLogger	$log

Protected Attributes inherited from ilMDSaxParser
bool	$md_in_md = false

string	$md_chr_data = ''

ilMDIdentifier	$md_ide = null

ilMDLanguage	$md_lan = null

ilMDDescription	$md_des = null

ilMDLifecycle	$md_lif = null

ilMDContribute	$md_con = null

ilMDEntity	$md_ent = null

ilMDMetaMetadata	$md_met = null

ilMDTechnical	$md_tec = null

ilMDFormat	$md_for = null

ilMDLocation	$md_loc = null

ilMDRequirement	$md_req = null

ilMDOrComposite	$md_orc = null

ilMDEducational	$md_edu = null

ilMDTypicalAgeRange	$md_typ = null

ilMDRights	$md_rig = null

ilMDRelation	$md_rel = null

ilMDIdentifier_	$md_ide_ = null

ilMDAnnotation	$md_ann = null

ilMDClassification	$md_cla = null

ilMDTaxonPath	$md_taxp = null

ilMDTaxon	$md_tax = null

ilMDKeyword	$md_key = null

array	$md_parent = array()

ilMD	$md = null

ilMDGeneral	$md_gen = null

ilLogger	$meta_log

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

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

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDParser::__construct	(	string	$a_obj_id,
		ilImportMapping	$a_mapping
	)

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

References $parts, ILIAS\GlobalScreen\Provider\__construct(), ilLoggerFactory\getLogger(), and ILIAS\Repository\int().

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

Here is the call graph for this function:

Member Function Documentation

◆ createLocalRecord()

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

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

References ilObject\_lookupType(), ilFileUtils\ilTempnam(), ilAdvancedMDRecordParser\MODE_INSERT, and ilAdvancedMDRecordParser\MODE_INSERT_VALIDATION.

Referenced by initValue().

                                                                                                               : void
     {
         $tmp_file = ilFileUtils::ilTempnam();
         file_put_contents($tmp_file, $a_xml);
 
         // see ilAdvancedMDSettingsGUI::importRecord()
         $parser = null;
         try {
             // the (old) record parser does only support files
             $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) {
             $this->log->error('Parsing failed with message: ' . $exc->getMessage());
             return;
         } finally {
             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) {
                 $import_ids = explode('_', $import_id);
                 $old_id = array_pop($import_ids);
                 $this->mapping->addMapping("components/ILIAS/AdvancedMetaData", "lfld", $old_id, (string) $new_id);
             }
         }
         $map_keys = array_keys($map);
         $new_id = array_shift($map_keys);
         $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 ( )

Returns: int[]

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

References $record_ids.

                                   : array
     {
         return $this->record_ids;
     }

◆ handlerBeginTag()

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

Start element handler.

Parameters

resource $a_xml_parser xml parser

Implements ilSaxSubsetParser.

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

References initValue().

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

Here is the call graph for this function:

◆ handlerCharacterData()

ilAdvancedMDParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_name
	)

Character data handler.

Parameters

resource $a_xml_parser xml parser

Implements ilSaxSubsetParser.

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

                                                                        : void
     {
         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,
		string	$a_name
	)

End element handler.

Parameters

resource $a_xml_parser xml parser

Implements ilSaxSubsetParser.

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

                                                                 : void
     {
         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	(	string	$a_import_id,
		string	$a_sub_type = `""`,
		int	$a_sub_id = `0`,
		int	$a_local_rec_id = `null`
	)

protected

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

References $rec_id, createLocalRecord(), ilAdvancedMDFieldDefinition\getInstanceByImportId(), and ILIAS\Repository\int().

Referenced by handlerBeginTag().

      : void {
         $this->current_value = null;
 
         // get parent objects
         $new_parent_id = (int) $this->mapping->getMapping("components/ILIAS/AdvancedMetaData", "parent", (string) $this->obj_id);
         $this->log->notice('Found new parent id:' . $new_parent_id);
         if (!$new_parent_id) {
             return;
         }
         $new_sub_id = '';
         if ($a_sub_type && strcmp($a_sub_type, '-') !== 0) {
             $new_sub_id = $this->mapping->getMapping(
                 "components/ILIAS/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(
                 (int) $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 59 of file class.ilAdvancedMDParser.php.

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

Field Documentation

◆ $cdata

string ilAdvancedMDParser::$cdata = ""

protected

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

◆ $current_value

ilAdvancedMDFieldDefinition ilAdvancedMDParser::$current_value = null

protected

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

◆ $local_rec_fields_map

array ilAdvancedMDParser::$local_rec_fields_map = []

protected

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

◆ $local_rec_map

array ilAdvancedMDParser::$local_rec_map = []

protected

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

◆ $local_record

array ilAdvancedMDParser::$local_record = null

protected

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

◆ $log

ilLogger ilAdvancedMDParser::$log

protected

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

◆ $mapping

ilImportMapping ilAdvancedMDParser::$mapping

protected

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

◆ $obj_id

int ilAdvancedMDParser::$obj_id

protected

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

◆ $rec_id

int ilAdvancedMDParser::$rec_id = 0

protected

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

Referenced by initValue().

◆ $record_ids

array ilAdvancedMDParser::$record_ids = []

protected

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

Referenced by getRecordIds().

◆ $sax_controller

ilSaxController ilAdvancedMDParser::$sax_controller = null

protected

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

◆ $value_records

array ilAdvancedMDParser::$value_records = []

protected

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

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

components/ILIAS/AdvancedMetaData/classes/class.ilAdvancedMDParser.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createLocalRecord()

◆ getRecordIds()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ initValue()

◆ setHandlers()

Field Documentation

◆ $cdata

◆ $current_value

◆ $local_rec_fields_map

◆ $local_rec_map

◆ $local_record

◆ $log

◆ $mapping

◆ $obj_id

◆ $rec_id

◆ $record_ids

◆ $sax_controller

◆ $value_records