Class for category export. More...

Inheritance diagram for ilContainerReferenceExporter:

Collaboration diagram for ilContainerReferenceExporter:

Public Member Functions
	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...

	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml. More...

	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...

	init ()
	Init method. 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...

Protected Member Functions
	initWriter (ilContainerReference $ref)

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

Class for category export.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e $Id$

Definition at line 12 of file class.ilContainerReferenceExporter.php.

Member Function Documentation

◆ getValidSchemaVersions()

ilContainerReferenceExporter::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

Definition at line 78 of file class.ilContainerReferenceExporter.php.

References array.

     {
         return array(
             "4.3.0" => array(
                 "namespace" => "http://www.ilias.de/Modules/CategoryReference/catr/4_3",
                 "xsd_file" => "ilias_catr_4_3.xsd",
                 "uses_dataset" => false,
                 "min" => "4.3.0",
                 "max" => "")
         );
     }

◆ getXmlExportHeadDependencies()

ilContainerReferenceExporter::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"

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

References $GLOBALS, array, ilExportOptions\getInstance(), initWriter(), and ilExportOptions\KEY_ROOT.

     {
         include_once './Services/Export/classes/class.ilExportOptions.php';
         $eo = ilExportOptions::getInstance();
 
         $obj_id = end($a_ids);
 
 
         $GLOBALS['ilLog']->write(__METHOD__ . ': ' . $obj_id);
         if ($eo->getOption(ilExportOptions::KEY_ROOT) != $obj_id) {
             return array();
         }
         if (count(ilExportOptions::getInstance()->getSubitemsForExport()) > 1) {
             return array(
                 array(
                     'component'         => 'Services/Container',
                     'entity'            => 'struct',
                     'ids'                       => $a_ids
                 )
             );
         }
         return array();
     }

Here is the call graph for this function:

◆ getXmlRepresentation()

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

Get xml.

Parameters

object	$a_entity
object	$a_schema_version
object	$a_id

Returns

Definition at line 56 of file class.ilContainerReferenceExporter.php.

References $GLOBALS, ilObject\_getAllReferences(), ilObjectFactory\getInstanceByRefId(), initWriter(), and ilContainerReferenceXmlWriter\MODE_EXPORT.

     {
         $ref_ref_id = end(ilObject::_getAllReferences($a_id));
         $ref = ilObjectFactory::getInstanceByRefId($ref_ref_id, false);
 
         if (!$ref instanceof ilContainerReference) {
             $GLOBALS['ilLog']->write(__METHOD__ . $a_id . ' is not instance of type category!');
             return '';
         }
         $writer = $this->initWriter($ref);
         $writer->setMode(ilContainerReferenceXmlWriter::MODE_EXPORT);
         $writer->export(false);
         return $writer->getXml();
     }