ilWikiDataSet Class Reference

Wiki Data set class. More...

Inheritance diagram for ilWikiDataSet:

Collaboration diagram for ilWikiDataSet:

Public Member Functions
	getSupportedVersions ($a_entity)
	Get supported versions.
	getXmlNamespace ($a_entity, $a_target_release)
	Get xml namespace.
	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data.
	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record.
Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor.
	init ($a_entity, $a_target_release)
	Init.
	readData ($a_entity, $a_version, $a_ids)
	Read data from DB.
	setExportDirectories ($a_relative, $a_absolute)
	Set export directories.
	setImportDirectory ($a_val)
	Set import directory.
	getImportDirectory ()
	Get import directory.
	setDSPrefix ($a_val)
	Set XML dataset namespace prefix.
	getDSPrefix ()
	Get XML dataset namespace prefix.
	getDSPrefixString ()
	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields.
	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string.
	getJsonRepresentation ()
	Get json representation.
	getXmlRepresentation ($a_entity, $a_target_release, $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 ...> ...
	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_target_release, $a_ids, $a_field="")
	Add records xml.
	getNamespaces (&$namespaces, $a_entity, $a_target_release)
	Get xml namespaces.
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version.
	getJsonRecord ($a_set)
	Get json record for version.
	getXmlTypes ($a_entity, $a_version)
	Get xml types.
	getJsonTypes ($a_entity, $a_version)
	Get json types.
	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten)
	getXMLEntityTag ($a_entity, $a_target_release)
	Get entity tag.
	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten)
	setImport ($a_val)
	Set import object.
	getImport ()
	Get import object.

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity.
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data.

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt

Detailed Description

Wiki Data set class.

This class implements the following entities:

• wiki: data from il_wiki_data

Author

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

Version

$Id$

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

Member Function Documentation

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

protected

Determine the dependent sets of data.

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

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

                return false;
        }

ilWikiDataSet::getSupportedVersions

(

$a_entity

)

Get supported versions.

Parameters

@return

Reimplemented from ilDataSet.

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

        {
                switch ($a_entity)
                {
                        case "wiki":
                                return array("4.1.0");

                        case "wpg":
                                return array("4.1.0");
                }
        }

ilWikiDataSet::getTypes (   $a_entity,   $a_version  )

protected

Get field types for entity.

Parameters

@return

Reimplemented from ilDataSet.

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

        {
                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");
                        }
                }

                if ($a_entity == "wpg")
                {
                        switch ($a_version)
                        {
                                case "4.1.0":
                                        return array(
                                                "Id" => "integer",
                                                "Title" => "text",
                                                "WikiId" => "integer");
                        }
                }

        }

ilWikiDataSet::getXmlNamespace	(		$a_entity,
			$a_target_release
	)

Get xml namespace.

Parameters

@return

Reimplemented from ilDataSet.

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

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

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

Import record.

Parameters

@return

Definition at line 152 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->setRating($a_rec["Rating"]);
                                $newObj->setIntroduction($a_rec["Introduction"]);
                                $newObj->update(true);
                                $this->current_obj = $newObj;
                                $a_mapping->addMapping("Modules/Wiki", "wiki", $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"]);
                                $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());
                                break;
                }
        }

Here is the call graph for this function:

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

Read data.

Parameters

@return

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

References $ilDB, and ilDataSet\getDirectDataFromQuery().

        {
                global $ilDB;

                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;
                        }
                }

                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;
                        }
                }

        }

Here is the call graph for this function:

---

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

• Modules/Wiki/classes/class.ilWikiDataSet.php