Wiki Data set class. More...

Inheritance diagram for ilWikiDataSet:

Collaboration diagram for ilWikiDataSet:

Public Member Functions
	__construct ()
	construct More...

	getSupportedVersions ()
	Get supported versions. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...

	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. More...

Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor. More...

	init ($a_entity, $a_schema_version)
	Init. More...

	getSupportedVersions ()
	Get supported version. More...

	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...

	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...

	setImportDirectory ($a_val)
	Set import directory. More...

	getImportDirectory ()
	Get import directory. More...

	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...

	getDSPrefix ()
	Get XML dataset namespace prefix. More...

	getDSPrefixString ()

	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...

	getJsonRepresentation ()
	Get json representation. More...

	getXmlRepresentation ( $a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ... More...

	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...

	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...

	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...

	getJsonRecord ($a_set)
	Get json record for version. More...

	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...

	getJsonTypes ($a_entity, $a_version)
	Get json types. More...

	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...

	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...

	setImport ($a_val)
	Set import object. More...

	getImport ()
	Get import object. More...

	setCurrentInstallationId ($a_val)
	Set current installation id. More...

	getCurrentInstallationId ()
	Get current installation id. More...

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity. More...

	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. More...

Protected Member Functions inherited from ilDataSet
	getTypes ($a_entity, $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	createObjectExportId ($a_type, $a_id)
	Build ilias export id. More...

	parseObjectExportId ($a_id, $a_fallback_id=null)
	Parse export id. More...

Protected Attributes
	$wiki_log

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt

const	EXPORT_NO_INST_ID = 1

const	EXPORT_ID_ILIAS_LOCAL = 2

const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3

const	EXPORT_ID_ILIAS_REMOTE = 4

const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5

const	EXPORT_ID = 6

const	EXPORT_ID_INVALID = 7

Detailed Description

Wiki Data set class.

This class implements the following entities:

wiki: data from il_wiki_data
wpg: data from il_wiki_page

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilWikiDataSet::__construct ( )

construct

Parameters

Definition at line 30 of file class.ilWikiDataSet.php.

References $DIC, and ilLoggerFactory\getLogger().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         parent::__construct();
         $this->wiki_log = ilLoggerFactory::getLogger('wiki');
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

ilWikiDataSet::getDependencies	(	$a_entity,
		$a_version,
		$a_rec,
		$a_ids
	)

protected

Determine the dependent sets of data.

Definition at line 251 of file class.ilWikiDataSet.php.

References array.

     {
         switch ($a_entity) {
             case "wiki":
                 return array(
                     "wpg" => array("ids" => $a_rec["Id"]),
                     "wiki_imp_page" => array("ids" => $a_rec["Id"])
                 );
         }
 
         return false;
     }

◆ getSupportedVersions()

ilWikiDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

Definition at line 46 of file class.ilWikiDataSet.php.

References array.

     {
         return array("4.1.0", "4.3.0", "4.4.0", "5.1.0");
     }

◆ getTypes()

ilWikiDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

Definition at line 68 of file class.ilWikiDataSet.php.

References array.

     {
         if ($a_entity == "wiki") {
             switch ($a_version) {
                 case "4.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "StartPage" => "text",
                         "Short" => "text",
                         "Introduction" => "text",
                         "Rating" => "integer");
                     
                 case "4.3.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "StartPage" => "text",
                         "Short" => "text",
                         "Introduction" => "text",
                         "Rating" => "integer",
                         "PublicNotes" => "integer",
                         // "ImpPages" => "integer",
                         "PageToc" => "integer",
                         "RatingSide" => "integer",
                         "RatingNew" => "integer",
                         "RatingExt" => "integer");
                     
                 case "4.4.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "StartPage" => "text",
                         "Short" => "text",
                         "Introduction" => "text",
                         "Rating" => "integer",
                         "PublicNotes" => "integer",
                         // "ImpPages" => "integer",
                         "PageToc" => "integer",
                         "RatingSide" => "integer",
                         "RatingNew" => "integer",
                         "RatingExt" => "integer",
                         "RatingOverall" => "integer");
 
                 case "5.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "StartPage" => "text",
                         "Short" => "text",
                         "Introduction" => "text",
                         "Rating" => "integer",
                         "PublicNotes" => "integer",
                         // "ImpPages" => "integer",
                         "PageToc" => "integer",
                         "RatingSide" => "integer",
                         "RatingNew" => "integer",
                         "RatingExt" => "integer",
                         "RatingOverall" => "integer",
                         "LinkMdValues" => "integer"
                         );
             }
         }
 
         if ($a_entity == "wpg") {
             switch ($a_version) {
                 case "4.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "WikiId" => "integer");
                     
                 case "4.3.0":
                 case "4.4.0":
                 case "5.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "WikiId" => "integer",
                         "Blocked" => "integer",
                         "Rating" => "integer");
             }
         }
 
         if ($a_entity == "wiki_imp_page") {
             switch ($a_version) {
                 case "5.1.0":
                     return array(
                         "WikiId" => "integer",
                         "PageId" => "integer",
                         "Ord" => "integer",
                         "Indent" => "integer");
             }
         }
         return array();
     }

◆ getXmlNamespace()

ilWikiDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

Definition at line 57 of file class.ilWikiDataSet.php.

     {
         return "http://www.ilias.de/xml/Modules/Wiki/" . $a_entity;
     }

◆ importRecord()

ilWikiDataSet::importRecord	(	$a_entity,
		$a_types,
		$a_rec,
		$a_mapping,
		$a_schema_version
	)

Import record.

Parameters

Definition at line 271 of file class.ilWikiDataSet.php.

References ilObjectFactory\getInstanceByObjId().

     {
         //echo $a_entity;
         //var_dump($a_rec);
 
         switch ($a_entity) {
             case "wiki":
                 
                 include_once("./Modules/Wiki/classes/class.ilObjWiki.php");
                 if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
                     $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                 } else {
                     $newObj = new ilObjWiki();
                     $newObj->setType("wiki");
                     $newObj->create(true);
                 }
                     
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 $newObj->setShortTitle($a_rec["Short"]);
                 $newObj->setStartPage($a_rec["StartPage"]);
                 $newObj->setRatingOverall($a_rec["RatingOverall"]);
                 $newObj->setRating($a_rec["Rating"]);
                 $newObj->setIntroduction($a_rec["Introduction"]);
                 $newObj->setPublicNotes($a_rec["PublicNotes"]);
                 
                 // >= 4.3
                 if (isset($a_rec["PageToc"])) {
                     // $newObj->setImportantPages($a_rec["ImpPages"]);
                     $newObj->setPageToc($a_rec["PageToc"]);
                     $newObj->setRatingAsBlock($a_rec["RatingSide"]);
                     $newObj->setRatingForNewPages($a_rec["RatingNew"]);
                     $newObj->setRatingCategories($a_rec["RatingExt"]);
                 }
                 $newObj->setLinkMetadataValues($a_rec["LinkMdValues"]);
                 
                 $newObj->update(true);
                 $this->current_obj = $newObj;
                 $a_mapping->addMapping("Modules/Wiki", "wiki", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping("Services/Object", "obj", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping("Services/Rating", "rating_category_parent_id", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping("Services/AdvancedMetaData", "parent", $a_rec["Id"], $newObj->getId());
                 break;
 
             case "wpg":
                 $wiki_id = $a_mapping->getMapping("Modules/Wiki", "wiki", $a_rec["WikiId"]);
                 include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                 $wpage = new ilWikiPage();
                 $wpage->setWikiId($wiki_id);
                 $wpage->setTitle($a_rec["Title"]);
                 
                 // >= 4.3
                 if (isset($a_rec["Blocked"])) {
                     $wpage->setBlocked($a_rec["Blocked"]);
                     $wpage->setRating($a_rec["Rating"]);
                 }
                 
                 $wpage->create(true);
                 
                 $a_mapping->addMapping("Modules/Wiki", "wpg", $a_rec["Id"], $wpage->getId());
                 $a_mapping->addMapping("Services/COPage", "pg", "wpg:" . $a_rec["Id"], "wpg:" . $wpage->getId());
                 $a_mapping->addMapping("Services/AdvancedMetaData", "advmd_sub_item", "advmd:wpg:" . $a_rec["Id"], $wpage->getId());
                 break;
 
             case "wiki_imp_page":
                 $wiki_id = $a_mapping->getMapping("Modules/Wiki", "wiki", $a_rec["WikiId"]);
                 $page_id = $a_mapping->getMapping("Modules/Wiki", "wpg", $a_rec["PageId"]);
                 if ($wiki_id > 0 && $page_id > 0 && is_object($this->current_obj) && $this->current_obj->getId() == $wiki_id) {
                     $this->current_obj->addImportantPage($page_id, $a_rec["Ord"], $a_rec["Indent"]);
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

ilWikiDataSet::readData	(	$a_entity,
		$a_version,
		$a_ids,
		$a_field = `""`
	)

Read data.

Parameters

Definition at line 175 of file class.ilWikiDataSet.php.

References ilDataSet\$db, $ilDB, array, and ilDataSet\getDirectDataFromQuery().

     {
         $ilDB = $this->db;
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
                 
         if ($a_entity == "wiki") {
             switch ($a_version) {
                 case "4.1.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description," .
                         " startpage start_page, short, rating, introduction" .
                         " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
                         " WHERE " . $ilDB->in("id", $a_ids, false, "integer"));
                     break;
                 
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description," .
                         " startpage start_page, short, rating, introduction," . // imp_pages,
                         " public_notes, page_toc, rating_side, rating_new, rating_ext" .
                         " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
                         " WHERE " . $ilDB->in("id", $a_ids, false, "integer"));
                     break;
                 
                 case "4.4.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description," .
                         " startpage start_page, short, rating, rating_overall, introduction," . // imp_pages,
                         " public_notes, page_toc, rating_side, rating_new, rating_ext" .
                         " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
                         " WHERE " . $ilDB->in("id", $a_ids, false, "integer"));
                     break;
 
                 case "5.1.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description," .
                         " startpage start_page, short, rating, rating_overall, introduction," . // imp_pages,
                         " public_notes, page_toc, rating_side, rating_new, rating_ext, link_md_values" .
                         " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
                         " WHERE " . $ilDB->in("id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "wpg") {
             switch ($a_version) {
                 case "4.1.0":
                     $this->getDirectDataFromQuery("SELECT id, title, wiki_id" .
                         " FROM il_wiki_page" .
                         " WHERE " . $ilDB->in("wiki_id", $a_ids, false, "integer"));
                     break;
                 
                 case "4.3.0":
                 case "4.4.0":
                 case "5.1.0":
                     $this->getDirectDataFromQuery("SELECT id, title, wiki_id," .
                         " blocked, rating" .
                         " FROM il_wiki_page" .
                         " WHERE " . $ilDB->in("wiki_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         if ($a_entity == "wiki_imp_page") {
             switch ($a_version) {
                 case "5.1.0":
                     $this->getDirectDataFromQuery("SELECT wiki_id, page_id, ord, indent " .
                         " FROM il_wiki_imp_pages " .
                         " WHERE " . $ilDB->in("wiki_id", $a_ids, false, "integer"));
                     break;
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $wiki_log

ilWikiDataSet::$wiki_log

protected

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

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

Modules/Wiki/classes/class.ilWikiDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()

Field Documentation

◆ $wiki_log