ilAdvancedMetaDataExporter Class Reference

Export class for adv md. More...

Inheritance diagram for ilAdvancedMetaDataExporter:

Collaboration diagram for ilAdvancedMetaDataExporter:

Public Member Functions
	init ()
	Initialisation. More...
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
Public Member Functions inherited from ilXmlExporter
	__construct ()
	setExport (ilExport $a_exp)
	getExport ()
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	init ()
	setExportDirectories (string $a_dir_relative, string $a_dir_absolute)
	getRelativeExportDirectory ()
	getAbsoluteExportDirectory ()
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion (string $a_entity, string $a_target_release)

Static Private Attributes
static array	$local_recs_done = []

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory (string $a_obj_type, int $a_obj_id, string $a_export_type='xml', string $a_entity="")
Protected Attributes inherited from ilXmlExporter
string	$dir_relative = ""
string	$dir_absolute = ""
ilExport	$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 12 of file class.ilAdvancedMetaDataExporter.php.

Member Function Documentation

getValidSchemaVersions()

ilAdvancedMetaDataExporter::getValidSchemaVersions

(

string

$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. Example: return array ( "4.1.0" => array( "namespace" => "http://www.ilias.de/Services/MetaData/md/4_1", "xsd_file" => "ilias_md_4_1.xsd", "min" => "4.1.0", "max" => "") );

Reimplemented from ilXmlExporter.

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

                                                            : array
    {
        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	(	string	$a_entity,
		string	$a_target_release,
		array	$a_ids
	)

Get head dependencies.

Returns

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

Reimplemented from ilXmlExporter.

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

                                                                                                          : array
    {
        return array();
    }

getXmlExportTailDependencies()

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

Get tail dependencies.

Returns

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

Reimplemented from ilXmlExporter.

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

                                                                                                          : array
    {
        return array();
    }

getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

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

                                                                                                  : string
    {
        $parts = explode(":", $a_id);
        if (sizeof($parts) != 2) {
            return "";
        }
        $obj_id = (int) $parts[0];
        $rec_id = (int) $parts[1];
 
        // any data for current record and object?
        $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);
        }
        return "";
    }

References $parts, $xml, ilAdvancedMDValues\findByObjectId(), and ILIAS\Repository\int().

Here is the call graph for this function:

init()

ilAdvancedMetaDataExporter::init

(

)

Initialisation.

Reimplemented from ilXmlExporter.

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

                          : void
    {
    }

Field Documentation

$local_recs_done

array ilAdvancedMetaDataExporter::$local_recs_done = []

staticprivate

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

---

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

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