ilAdvancedMetaDataExporter Class Reference

Export class for adv md. More...

Inheritance diagram for ilAdvancedMetaDataExporter:

Collaboration diagram for ilAdvancedMetaDataExporter:

Public Member Functions
	init ()
	Initialisation. More...
	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
Public Member Functions inherited from ilXmlExporter
	__construct ()
	Constructor. More...
	setExport (ilExport $a_exp)
	Set export object. More...
	getExport ()
	Get export. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...
	init ()
	setExportDirectories ($a_dir_relative, $a_dir_absolute)
	Export directories. More...
	getRelativeExportDirectory ()
	Get relative export directory. More...
	getAbsoluteExportDirectory ()
	Get absolute export directory. More...
	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion ($a_entity, $a_target_release)
	Determine schema version. More...

Private Attributes
	$ds

Static Private Attributes
static	$local_recs_done = array()

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
	export directory lookup More...
Protected Attributes inherited from ilXmlExporter
	$dir_relative
	$dir_absolute
	$exp

Detailed Description

Export class for adv md.

Author

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

Version

Id

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

Member Function Documentation

getValidSchemaVersions()

ilAdvancedMetaDataExporter::getValidSchemaVersions

(

$a_entity

)

Returns schema versions that the component can export to.

ILIAS chooses the first one, that has min/max constraints which fit to the target release. Please put the newest on top.

Returns

Reimplemented from ilXmlExporter.

Definition at line 185 of file class.ilAdvancedMetaDataExporter.php.

        {
                return array (
                        "4.4.0" => array(
                                "namespace" => "http://www.ilias.de/Services/AdvancedMetaData/advmd/4_4",
                                "xsd_file" => "ilias_advmd_4_4.xsd",
                                "uses_dataset" => true,
                                "min" => "4.4.0",
                                "max" => "")
                );
        }

getXmlExportHeadDependencies()

ilAdvancedMetaDataExporter::getXmlExportHeadDependencies	(		$a_entity,
			$a_target_release,
			$a_ids
	)

Get head dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

array array of array with keys "component", entity", "ids"

Reimplemented from ilXmlExporter.

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

        {
                return array();
        }

getXmlExportTailDependencies()

ilAdvancedMetaDataExporter::getXmlExportTailDependencies	(		$a_entity,
			$a_target_release,
			$a_ids
	)

Get tail dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

array array of array with keys "component", entity", "ids"

Reimplemented from ilXmlExporter.

Definition at line 49 of file class.ilAdvancedMetaDataExporter.php.

        {
                return array();
        }

getXmlRepresentation()

ilAdvancedMetaDataExporter::getXmlRepresentation	(		$a_entity,
			$a_schema_version,
			$a_id
	)

Get xml representation.

Parameters

string	entity
string	schema version
string	id

Returns

string xml string

Reimplemented from ilXmlExporter.

Definition at line 62 of file class.ilAdvancedMetaDataExporter.php.

        {                               
                $parts = explode(":", $a_id);
                if(sizeof($parts) != 2)
                {
                        return;
                }
                $obj_id = $parts[0];
                $rec_id = $parts[1];
                
                // any data for current record and object?
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                $raw = ilAdvancedMDValues::findByObjectId($obj_id);
                if(!$raw)
                {
                        return;
                }
                
                // gather sub-item data from value entries
                $sub_items = array();
                foreach($raw as $item)
                {
                        $sub_items[$item["sub_type"]][] = $item["sub_id"];
                }
                
                // gather all relevant data
                $items = array();
                foreach($sub_items as $sub_type => $sub_ids)
                {                                               
                        foreach(array_unique($sub_ids) as $sub_id)
                        {
                                $values_record = new ilAdvancedMDValues($rec_id, $obj_id, $sub_type, $sub_id);
                                $defs = $values_record->getDefinitions();                       
                                $values_record->read();
                                foreach($values_record->getADTGroup()->getElements() as $element_id => $element)
                                {                                       
                                        if(!$element->isNull())
                                        {
                                                $def = $defs[$element_id];                                                      
                                                $items[$rec_id][] =array(
                                                        'id' => $def->generateImportId($def->getFieldId()),
                                                        'sub_type' => $sub_type,
                                                        'sub_id' => $sub_id,
                                                        'value' => $def->getValueForXML($element)
                                                );
                                        }                                       
                                }                               
                        }
                }
                
                // #17066 - local advmd record
                $local_recs = array();
                $rec_obj = new ilAdvancedMDRecord($rec_id);             
                if($rec_obj->getParentObject())
                {
                        $xml = new ilXmlWriter; 
                        $rec_obj->toXML($xml);
                        $xml = $xml->xmlDumpMem(false);
                        
                        $local_recs[$rec_obj->getRecordId()] = base64_encode($xml);                     
                }
                
                // we only want non-empty fields
                if(sizeof($items))
                {                       
                        $xml = new ilXmlWriter; 
                        
                        foreach($items as $record_id => $record_items)
                        {
                                $xml->xmlStartTag('AdvancedMetaData');
                                
                                $is_local = array_key_exists($record_id, $local_recs);
 
                                // add local record data?
                                if($is_local)
                                {
                                        // we need to add this only once
                                        if(!array_key_exists($record_id, self::$local_recs_done))
                                        {
                                                $xml->xmlElement(
                                                        'Record', 
                                                        array('local_id' => $record_id),
                                                        $local_recs[$record_id]
                                                );
                                                
                                                self::$local_recs_done[] = $record_id;
                                        }
                                }
                
                                foreach($record_items as $item)
                                {
                                        $att = array(
                                                'id' => $item['id'],
                                                'sub_type' => $item['sub_type'],
                                                'sub_id' => $item['sub_id']
                                        );
                                        
                                        if($is_local)
                                        {
                                                $att['local_rec_id'] = $record_id;
                                        }
                                        
                                        $xml->xmlElement(
                                                'Value',
                                                $att,
                                                $item['value']
                                        );
                                }
                                
                                $xml->xmlEndTag('AdvancedMetaData');    
                        }
                                                                        
                        return $xml->xmlDumpMem(false);
                }                                                               
        }       

References ilAdvancedMDValues\findByObjectId(), ilXmlWriter\xmlDumpMem(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

init()

ilAdvancedMetaDataExporter::init

(

)

Initialisation.

Reimplemented from ilXmlExporter.

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

        {
                
        }

Field Documentation

$ds

ilAdvancedMetaDataExporter::$ds

private

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

$local_recs_done

ilAdvancedMetaDataExporter::$local_recs_done = array()

staticprivate

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

---

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

• Services/AdvancedMetaData/classes/class.ilAdvancedMetaDataExporter.php