Exporter class for meta data. More...

Inheritance diagram for ilCOPageExporter:

Collaboration diagram for ilCOPageExporter:

Public Member Functions
	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...

Protected Attributes
	$config

	$plugin_dependencies = array()

Protected Attributes inherited from ilXmlExporter
	$dir_relative

	$dir_absolute

	$exp

Private Attributes
	$ds

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

Detailed Description

Exporter class for meta data.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

Id

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

Member Function Documentation

◆ getValidSchemaVersions()

ilCOPageExporter::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 221 of file class.ilCOPageExporter.php.

References $id, $nodes, ilPageComponentPluginExporter\setPCProperties(), and ilPageComponentPluginExporter\setPCVersion().

     {
         if ($a_entity == "pg") {
             return array(
                 "4.2.0" => array(
                     "namespace" => "http://www.ilias.de/Services/COPage/pg/4_2",
                     "xsd_file" => "ilias_pg_4_2.xsd",
                     "min" => "4.2.0",
                     "max" => ""),
                 "4.1.0" => array(
                     "namespace" => "http://www.ilias.de/Services/COPage/pg/4_1",
                     "xsd_file" => "ilias_pg_4_1.xsd",
                     "min" => "4.1.0",
                     "max" => "4.1.99")
             );
         }
         if ($a_entity == "pgtp") {
             return array(
                 "4.2.0" => array(
                     "namespace" => "http://www.ilias.de/Services/COPage/pgtp/4_1",
                     "xsd_file" => "ilias_pgtp_4_1.xsd",
                     "uses_dataset" => true,
                     "min" => "4.2.0",
                     "max" => "")
             );
         }
     }

Here is the call graph for this function:

◆ getXmlExportHeadDependencies()

ilCOPageExporter::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 81 of file class.ilCOPageExporter.php.

References $files, $lang, ilObjFile\_getFilesOfObject(), ilObjMediaObject\_getMobsOfObject(), and ilObject\_lookupType().

     {
         if ($a_entity == "pg") {
             // get all media objects and files of the page
             include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
             include_once("./Modules/File/classes/class.ilObjFile.php");
             $mob_ids = array();
             $file_ids = array();
             foreach ($a_ids as $pg_id) {
                 $pg_id = explode(":", $pg_id);
 
                 $lang = ($this->config->getMasterLanguageOnly())
                     ? "-"
                     : "";
     
                 // get media objects
                 if ($this->config->getIncludeMedia()) {
                     $mids = ilObjMediaObject::_getMobsOfObject($pg_id[0] . ":pg", $pg_id[1], 0, $lang);
                     foreach ($mids as $mid) {
                         if (ilObject::_lookupType($mid) == "mob") {
                             $mob_ids[] = $mid;
                         }
                     }
                 }
     
                 // get files
                 $files = ilObjFile::_getFilesOfObject($pg_id[0] . ":pg", $pg_id[1], 0, $lang);
                 foreach ($files as $file) {
                     if (ilObject::_lookupType($file) == "file") {
                         $file_ids[] = $file;
                     }
                 }
             }
     
             return array(
                 array(
                     "component" => "Services/MediaObjects",
                     "entity" => "mob",
                     "ids" => $mob_ids),
                 array(
                     "component" => "Modules/File",
                     "entity" => "file",
                     "ids" => $file_ids)
                 );
         }
         
         return array();
     }

Here is the call graph for this function:

◆ getXmlExportTailDependencies()

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

Definition at line 138 of file class.ilCOPageExporter.php.

References $id.

     {
         if ($a_entity == "pgtp") {
             $pg_ids = array();
             foreach ($a_ids as $id) {
                 $pg_ids[] = "stys:" . $id;
             }
     
             return array(
                 array(
                     "component" => "Services/COPage",
                     "entity" => "pg",
                     "ids" => $pg_ids)
                 );
         }
 
         if (!empty($this->plugin_dependencies)) {
             // use numeric keys instead plugin names
             return array_values($this->plugin_dependencies);
         }
 
         return array();
     }

◆ getXmlRepresentation()

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

Get xml representation.

Parameters

string	entity
string	schema version
array	ids

Returns: string xml

Definition at line 171 of file class.ilCOPageExporter.php.

References $id, $l, $t, $xml, ilPageObjectFactory\getInstance(), and ilPageObject\lookupTranslations().

     {
         if ($a_entity == "pg") {
             include_once("./Services/COPage/classes/class.ilPageObject.php");
             
             $id = explode(":", $a_id);
 
             $langs = array("-");
             if (!$this->config->getMasterLanguageOnly()) {
                 $trans = ilPageObject::lookupTranslations($id[0], $id[1]);
                 foreach ($trans as $t) {
                     if ($t != "-") {
                         $langs[] = $t;
                     }
                 }
             }
 
             include_once("./Services/COPage/classes/class.ilPageObjectFactory.php");
             $xml = "";
             foreach ($langs as $l) {
                 $page_object = ilPageObjectFactory::getInstance($id[0], $id[1], 0, $l);
                 $page_object->buildDom();
                 $page_object->insertInstIntoIDs(IL_INST_ID);
                 $this->extractPluginProperties($page_object);
                 $pxml = $page_object->getXMLFromDom(false, false, false, "", true);
                 $pxml = str_replace("&", "&amp;", $pxml);
                 $a_media = ($this->config->getIncludeMedia())
                     ? ""
                     : 'WithoutMedia="1"';
                 $xml .= '<PageObject Language="' . $l . '" Active="' . $page_object->getActive() . '" ActivationStart="' . $page_object->getActivationStart() . '" ActivationEnd="' .
                     $page_object->getActivationEnd() . '" ShowActivationInfo="' . $page_object->getShowActivationInfo() . '" ' . $a_media . '>';
                 $xml .= $pxml;
                 $xml .= "</PageObject>";
                 $page_object->freeDom();
             }
     
             return $xml;
         }
         if ($a_entity == "pgtp") {
             return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $config

ilCOPageExporter::$config

protected

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

◆ $ds

ilCOPageExporter::$ds

private

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

◆ $plugin_dependencies

ilCOPageExporter::$plugin_dependencies = array()

protected

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

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

Services/COPage/classes/class.ilCOPageExporter.php

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getValidSchemaVersions()

◆ getXmlExportHeadDependencies()

◆ getXmlExportTailDependencies()

◆ getXmlRepresentation()

Field Documentation

◆ $config

◆ $ds

◆ $plugin_dependencies