ilWikiDataSet Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilWikiDataSet:

Collaboration diagram for ilWikiDataSet:

Public Member Functions
	__construct ()
	getSupportedVersions ()
	readData (string $a_entity, string $a_version, array $a_ids)
	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
Public Member Functions inherited from ilDataSet
	__construct ()
	init (string $a_entity, string $a_schema_version)
	Init. More...
	getSupportedVersions ()
	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...
	initByExporter (ilXmlExporter $xml_exporter)
	setImportDirectory (string $a_val)
	getImportDirectory ()
	setDSPrefix (string $a_val)
	getDSPrefix ()
	getDSPrefixString ()
	getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...
	convertToLeadingUpper (string $a_str)
	Make xyz_abc a XyzAbc string. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $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 (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")
	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)
	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)
	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...
	getXmlTypes (string $a_entity, string $a_version)
	Get xml types. More...
	getXMLEntityName (string $a_entity, string $a_version)
	Get entity name for xml (may be overwritten) More...
	getXMLEntityTag (string $a_entity, string $a_schema_version)
	Get entity tag. More...
	setImport (ilSurveyImporter $a_val)
	getImport ()
	setCurrentInstallationId (string $a_val)
	getCurrentInstallationId ()
	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...
	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)
	getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)
	getTypes (string $a_entity, string $a_version)
	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
Protected Member Functions inherited from ilDataSet
	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...
	getXmlNamespace (string $a_entity, string $a_schema_version)
	getExportDirInContainer (string $exp_dir)
	getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")
	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	createObjectExportId (string $a_type, string $a_id)
	Build ilias export id. More...
	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...
	stripTags (array $rec, array $omit_keys=[])

Protected Attributes
ILIAS Wiki Navigation ImportantPageDBRepository	$imp_page_repo
ilObjWiki	$current_obj = null
ilLogger	$wiki_log
Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss
string	$current_installation_id = ""
array	$data = []
ilDBInterface	$db
ilLogger	$ds_log
string	$import_directory = ""
string	$entity = ""
string	$schema_version = ""
string	$component_export_dir = ""
string	$ds_prefix = "ds"
string	$version = ""
ilSurveyImporter	$import
ilExport	$export

Additional Inherited Members
Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'
const	DATASET_NS_PREFIX = 'ds'
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
int	$dircnt = 0

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Wiki Data set class

This class implements the following entities:

• wiki: data from il_wiki_data
• wpg: data from il_wiki_page

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilWikiDataSet::__construct

(

)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ilLoggerFactory\getLogger().

    {
        global $DIC;

        $this->db = $DIC->database();
        parent::__construct();
        $this->wiki_log = ilLoggerFactory::getLogger('wiki');
        $this->imp_page_repo = $DIC->wiki()->internal()->repo()->importantPage();
    }

Here is the call graph for this function:

Member Function Documentation

getDependencies()

ilWikiDataSet::getDependencies ( string  $a_entity, string  $a_version, ?array  $a_rec = null, ?array  $a_ids = null  )

protected

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

References null.

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

        return [];
    }

getSupportedVersions()

ilWikiDataSet::getSupportedVersions

(

)

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

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

getTypes()

ilWikiDataSet::getTypes ( string  $a_entity, string  $a_version  )

protected

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

                                                                    : 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"
                    );

                case "5.4.0":
                case "8.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",
                        "EmptyPageTempl" => "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");

                case "5.4.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "WikiId" => "integer",
                        "Blocked" => "integer",
                        "Rating" => "integer",
                        "TemplateNewPages" => "integer",
                        "TemplateAddToPage" => "integer"
                    );

                case "8.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "WikiId" => "integer",
                        "Blocked" => "integer",
                        "Rating" => "integer",
                        "TemplateNewPages" => "integer",
                        "TemplateAddToPage" => "integer",
                        "Lang" => "text"
                    );
            }
        }

        if ($a_entity === "wiki_imp_page") {
            switch ($a_version) {
                case "5.1.0":
                case "5.4.0":
                case "8.0":
                    return array(
                        "WikiId" => "integer",
                        "PageId" => "integer",
                        "Ord" => "integer",
                        "Indent" => "integer");
            }
        }
        return array();
    }

getXmlNamespace()

ilWikiDataSet::getXmlNamespace ( string  $a_entity, string  $a_schema_version  )

protected

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

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

importRecord()

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

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

References $lang, ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ILIAS\Repository\int(), and ilDataSet\stripTags().

     : void {
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "wiki":

                if ($new_id = $a_mapping->getMapping('components/ILIAS/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->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->setEmptyPageTemplate((int) $a_rec["EmptyPageTempl"]);

                $newObj->update(true);
                $this->current_obj = $newObj;
                $a_mapping->addMapping("components/ILIAS/Wiki", "wiki", $a_rec["Id"], $newObj->getId());
                $a_mapping->addMapping("components/ILIAS/ILIASObject", "obj", $a_rec["Id"], $newObj->getId());
                $a_mapping->addMapping("components/ILIAS/Rating", "rating_category_parent_id", $a_rec["Id"], $newObj->getId());
                $a_mapping->addMapping("components/ILIAS/AdvancedMetaData", "parent", $a_rec["Id"], $newObj->getId());
                break;

            case "wpg":
                $wiki_id = $a_mapping->getMapping("components/ILIAS/Wiki", "wiki", $a_rec["WikiId"]);
                $lang = ($a_rec["Lang"] ?? "");
                $wpage = new ilWikiPage();
                if (!in_array($lang, ["", "-"])) {
                    $wpage->setLanguage($lang);
                }
                $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);

                if (isset($a_rec["TemplateNewPages"]) || isset($a_rec["TemplateAddToPage"])) {
                    $wtpl = new ilWikiPageTemplate($wiki_id);
                    $wtpl->save($wpage->getId(), (int) $a_rec["TemplateNewPages"], (int) $a_rec["TemplateAddToPage"]);
                }

                $a_mapping->addMapping("components/ILIAS/Wiki", "wpg", $a_rec["Id"], $wpage->getId());
                $a_mapping->addMapping("components/ILIAS/COPage", "pg", "wpg:" . $a_rec["Id"], "wpg:" . $wpage->getId());
                $a_mapping->addMapping("components/ILIAS/AdvancedMetaData", "advmd_sub_item", "advmd:wpg:" . $a_rec["Id"], $wpage->getId());
                break;

            case "wiki_imp_page":
                $wiki_id = $a_mapping->getMapping("components/ILIAS/Wiki", "wiki", $a_rec["WikiId"]);
                $page_id = $a_mapping->getMapping("components/ILIAS/Wiki", "wpg", $a_rec["PageId"]);
                if ($wiki_id > 0 && $page_id > 0 && is_object($this->current_obj) && $this->current_obj->getId() === (int) $wiki_id) {
                    $this->imp_page_repo->add($this->current_obj->getId(), (int) $page_id, (int) $a_rec["Ord"], (int) $a_rec["Indent"]);
                }
                break;
        }
    }

Here is the call graph for this function:

readData()

ilWikiDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

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

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

                                                                               : void
    {
        $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;

                case "5.4.0":
                case "8.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, empty_page_templ" .
                        " 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;

                case "5.4.0":
                    $this->getDirectDataFromQuery("SELECT id, title, wiki_id," .
                        " blocked, rating" .
                        " FROM il_wiki_page" .
                        " WHERE " . $ilDB->in("wiki_id", $a_ids, false, "integer"));
                    foreach ($this->data as $k => $v) {
                        $set = $ilDB->queryF(
                            "SELECT * FROM wiki_page_template " .
                            " WHERE wiki_id = %s " .
                            " AND wpage_id = %s ",
                            ["integer", "integer"],
                            [$v["WikiId"], $v["Id"]]
                        );
                        if ($rec = $ilDB->fetchAssoc($set)) {
                            $this->data[$k]["TemplateNewPages"] = $rec["new_pages"];
                            $this->data[$k]["TemplateAddToPage"] = $rec["add_to_page"];
                        }
                    }
                    break;

                case "8.0":
                    $this->getDirectDataFromQuery("SELECT id, title, wiki_id," .
                        " blocked, rating, lang" .
                        " FROM il_wiki_page" .
                        " WHERE " . $ilDB->in("wiki_id", $a_ids, false, "integer"));
                    foreach ($this->data as $k => $v) {
                        $set = $ilDB->queryF(
                            "SELECT * FROM wiki_page_template " .
                            " WHERE wiki_id = %s " .
                            " AND wpage_id = %s ",
                            ["integer", "integer"],
                            [$v["WikiId"], $v["Id"]]
                        );
                        if ($rec = $ilDB->fetchAssoc($set)) {
                            $this->data[$k]["TemplateNewPages"] = $rec["new_pages"];
                            $this->data[$k]["TemplateAddToPage"] = $rec["add_to_page"];
                        }
                    }
                    break;
            }
        }

        if ($a_entity === "wiki_imp_page") {
            switch ($a_version) {
                case "5.1.0":
                case "5.4.0":
                case "8.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

$current_obj

ilObjWiki ilWikiDataSet::$current_obj = null

protected

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

$imp_page_repo

ILIAS Wiki Navigation ImportantPageDBRepository ilWikiDataSet::$imp_page_repo

protected

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

$wiki_log

ilLogger ilWikiDataSet::$wiki_log

protected

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

---

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

• components/ILIAS/Wiki/classes/class.ilWikiDataSet.php