Exporter class for wikis. More...

Inheritance diagram for ilWikiExporter:

Collaboration diagram for ilWikiExporter:

Public Member Functions
	init ()
	Initialisation. 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 Member Functions
	getActiveAdvMDRecords ($a_id)

Protected Attributes
	$wiki_log

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

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

Member Function Documentation

◆ getActiveAdvMDRecords()

ilWikiExporter::getActiveAdvMDRecords ( $a_id )

protected

Definition at line 117 of file class.ilWikiExporter.php.

References ilAdvancedMDRecord\_getActivatedRecordsByObjectType(), array, and ilAdvancedMDRecord\getObjRecSelection().

Referenced by getXmlExportTailDependencies().

         {                       
                 include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
                 $active = array();
                 // selected globals
                 $sel_globals = ilAdvancedMDRecord::getObjRecSelection($a_id, "wpg");
 
                 foreach(ilAdvancedMDRecord::_getActivatedRecordsByObjectType("wiki", "wpg") as $record_obj)
                 {
                         // local ones and globally activated for the object
                         if ($record_obj->getParentObject() == $a_id || in_array($record_obj->getRecordId(), $sel_globals))
                         {
                                 $active[] = $record_obj->getRecordId();
                         }
                 }
 
                 $this->wiki_log->debug("active md rec: ".print_r($active, true));
 
                 return $active;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidSchemaVersions()

ilWikiExporter::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 158 of file class.ilWikiExporter.php.

References array.

         {
                 return array (
                         "4.1.0" => array(
                                 "namespace" => "http://www.ilias.de/Modules/Wiki/wiki/4_1",
                                 "xsd_file" => "ilias_wiki_4_1.xsd",
                                 "uses_dataset" => true,
                                 "min" => "4.1.0",
                                 "max" => "4.2.99"),
                         "4.3.0" => array(
                                 "namespace" => "http://www.ilias.de/Modules/Wiki/wiki/4_3",
                                 "xsd_file" => "ilias_wiki_4_3.xsd",
                                 "uses_dataset" => true,
                                 "min" => "4.3.0",
                                 "max" => "4.3.99"),
                         "4.4.0" => array(
                                 "namespace" => "http://www.ilias.de/Modules/Wiki/wiki/4_4",
                                 "xsd_file" => "ilias_wiki_4_4.xsd",
                                 "uses_dataset" => true,
                                 "min" => "4.4.0",
                                 "max" => "5.0.99"),
                         "5.1.0" => array(
                                 "namespace" => "http://www.ilias.de/Modules/Wiki/wiki/5_1",
                                 "xsd_file" => "ilias_wiki_5_1.xsd",
                                 "uses_dataset" => true,
                                 "min" => "5.1.0",
                                 "max" => "")
                 );
         }

◆ getXmlExportTailDependencies()

ilWikiExporter::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 45 of file class.ilWikiExporter.php.

References ilPageObject\_exists(), array, getActiveAdvMDRecords(), and ilWikiPage\getAllWikiPages().

         {
                 include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                 $pg_ids = array();
                 foreach ($a_ids as $id)
                 {
                         $pages = ilWikiPage::getAllWikiPages($id);
                         foreach ($pages as $p)
                         {
                                 if (ilWikiPage::_exists("wpg", $p["id"]))
                                 {
                                         $pg_ids[] = "wpg:".$p["id"];
                                 }
                         }
                 }
 
                 $deps = array (
                         array(
                                 "component" => "Services/COPage",
                                 "entity" => "pg",
                                 "ids" => $pg_ids),
                         array(
                                 "component" => "Services/Rating",
                                 "entity" => "rating_category",
                                 "ids" => $a_ids
                                 )
                         );
                 
                 $advmd_ids = array();
                 foreach($a_ids as $id)
                 {
                         $rec_ids = $this->getActiveAdvMDRecords($id);
                         $this->wiki_log->debug("advmd rec ids: wiki id:".$id.", adv rec ids".print_r($rec_ids, true));
                         if(sizeof($rec_ids))
                         {
                                 foreach($rec_ids as $rec_id)
                                 {
                                         $advmd_ids[] = $id.":".$rec_id;
                                 }
                         }                               
                 }
 
                 $this->wiki_log->debug("advmd ids: ".print_r($advmd_ids, true));
 
                 if(sizeof($advmd_ids))
                 {
                         $deps[] = array(
                                 "component" => "Services/AdvancedMetaData",
                                 "entity" => "advmd",
                                 "ids" => $advmd_ids
                         );      
                 }
 
                 // style
                 $obj_ids = (is_array($a_ids))
                         ? $a_ids
                         : array($a_ids);
                 $deps[] = array(
                         "component" => "Services/Style",
                         "entity" => "object_style",
                         "ids" => $obj_ids
                 );
 
                 // service settings
                 $deps[] = array(
                         "component" => "Services/Object",
                         "entity" => "service_settings",
                         "ids" => $a_ids);
 
                 return $deps;
         }

Here is the call graph for this function:

◆ getXmlRepresentation()

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

Get xml representation.

Parameters

string	entity
string	target release
string	id

Returns: string xml string

Definition at line 146 of file class.ilWikiExporter.php.

         {
                 return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
         }

◆ init()

ilWikiExporter::init ( )

Initialisation.

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

References ilLoggerFactory\getLogger().

         {
                 include_once("./Modules/Wiki/classes/class.ilWikiDataSet.php");
                 $this->ds = new ilWikiDataSet();
                 $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
                 $this->ds->setDSPrefix("ds");
 
                 $this->wiki_log = ilLoggerFactory::getLogger('wiki');
         }

Here is the call graph for this function:

Field Documentation

◆ $ds

ilWikiExporter::$ds

private

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

◆ $wiki_log

ilWikiExporter::$wiki_log

protected

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

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

Modules/Wiki/classes/class.ilWikiExporter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getActiveAdvMDRecords()

◆ getValidSchemaVersions()

◆ getXmlExportTailDependencies()

◆ getXmlRepresentation()

◆ init()

Field Documentation

◆ $ds

◆ $wiki_log