Inheritance diagram for ilAdvancedMDParser:

Collaboration diagram for ilAdvancedMDParser:

Public Member Functions
	__construct ($a_obj_id, $a_mapping)

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

	getRecordIds ()

Public Member Functions inherited from ilMDSaxParser
	ilMDSaxParser ($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 ()

	ilMDSaxParser ($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
	ilSaxParser ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object @access 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 @access 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...

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

Protected Member Functions
	initValue ($a_import_id, $a_sub_type="", $a_sub_id=0)

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

Additional Inherited Members
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 30 of file class.ilAdvancedMDParser.php.

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

Member Function Documentation

◆ getRecordIds()

ilAdvancedMDParser::getRecordIds ( )

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

        {
                return $this->record_ids;
        }

References $record_ids.

◆ handlerBeginTag()

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

handler for begin of element

Reimplemented from ilMDSaxParser.

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

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

References initValue().

Here is the call graph for this function:

◆ handlerCharacterData()

ilAdvancedMDParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

Reimplemented from ilMDSaxParser.

Definition at line 84 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
	)

handler for end of element

Reimplemented from ilMDSaxParser.

Definition at line 61 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 'Value':
                                $value = trim($this->cdata);
                                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`
	)

protected

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

        {
                $this->current_value = null;
                
                if($field = ilAdvancedMDFieldDefinition::getInstanceByImportId($a_import_id))
                {               
                        $rec_id = $field->getRecordId();
                                                
                        $new_parent_id = $this->mapping->getMapping("Services/AdvancedMetaData", "parent", $this->obj_id);
                        if(!$new_parent_id)
                        {
                                return;
                        }
                        
                        if($a_sub_type)
                        {                                                               
                                $new_sub_id = $this->mapping->getMapping("Services/AdvancedMetaData", "advmd_sub_item", "advmd:".$a_sub_type.":".$a_sub_id);                                            
                                if(!$new_sub_id)
                                {
                                        return;
                                }
                                                        
                                $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();
 
                        foreach($this->value_records[$rec_idx]->getDefinitions() as $def)
                        {                                                                               
                                if($a_import_id == $def->getImportId())
                                {
                                        $this->current_value = $def;
                                        break;
                                }
                        }
                        
                        // valid field found, record will be imported
                        if($this->current_value)
                        {                                                               
                                $this->record_ids[$new_parent_id][$a_sub_type][] = $rec_id;
                        }
                }       
        }

References $rec_id, and ilAdvancedMDFieldDefinition\getInstanceByImportId().

Referenced by handlerBeginTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilAdvancedMDParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser @access private

Reimplemented from ilMDSaxParser.

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

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

Field Documentation

◆ $cdata

ilAdvancedMDParser::$cdata

protected

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

◆ $current_record

ilAdvancedMDParser::$current_record

protected

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

◆ $current_value

ilAdvancedMDParser::$current_value

protected

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

◆ $has_values

ilAdvancedMDParser::$has_values

protected

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

◆ $mapping

ilAdvancedMDParser::$mapping

protected

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

◆ $obj_id

ilAdvancedMDParser::$obj_id

protected

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

◆ $rec_id

ilAdvancedMDParser::$rec_id

protected

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

Referenced by initValue().

◆ $record_ids

ilAdvancedMDParser::$record_ids = array()

protected

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

Referenced by getRecordIds().

◆ $value_records

ilAdvancedMDParser::$value_records = array()

protected

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

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

Services/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

◆ getRecordIds()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ initValue()

◆ setHandlers()

Field Documentation

◆ $cdata

◆ $current_record

◆ $current_value

◆ $has_values

◆ $mapping

◆ $obj_id

◆ $rec_id

◆ $record_ids

◆ $value_records