ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
class.ilWikiDataSet.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */
3 
4 include_once("./Services/DataSet/classes/class.ilDataSet.php");
5 
17 class ilWikiDataSet extends ilDataSet
18 {
22  protected $wiki_log;
23 
30  function __construct()
31  {
32  parent::__construct();
33  $this->wiki_log = ilLoggerFactory::getLogger('wiki');
34  }
35 
36 
43  public function getSupportedVersions()
44  {
45  return array("4.1.0", "4.3.0", "4.4.0", "5.1.0");
46  }
47 
54  function getXmlNamespace($a_entity, $a_schema_version)
55  {
56  return "http://www.ilias.de/xml/Modules/Wiki/".$a_entity;
57  }
58 
65  protected function getTypes($a_entity, $a_version)
66  {
67  if ($a_entity == "wiki")
68  {
69  switch ($a_version)
70  {
71  case "4.1.0":
72  return array(
73  "Id" => "integer",
74  "Title" => "text",
75  "Description" => "text",
76  "StartPage" => "text",
77  "Short" => "text",
78  "Introduction" => "text",
79  "Rating" => "integer");
80 
81  case "4.3.0":
82  return array(
83  "Id" => "integer",
84  "Title" => "text",
85  "Description" => "text",
86  "StartPage" => "text",
87  "Short" => "text",
88  "Introduction" => "text",
89  "Rating" => "integer",
90  "PublicNotes" => "integer",
91  // "ImpPages" => "integer",
92  "PageToc" => "integer",
93  "RatingSide" => "integer",
94  "RatingNew" => "integer",
95  "RatingExt" => "integer");
96 
97  case "4.4.0":
98  return array(
99  "Id" => "integer",
100  "Title" => "text",
101  "Description" => "text",
102  "StartPage" => "text",
103  "Short" => "text",
104  "Introduction" => "text",
105  "Rating" => "integer",
106  "PublicNotes" => "integer",
107  // "ImpPages" => "integer",
108  "PageToc" => "integer",
109  "RatingSide" => "integer",
110  "RatingNew" => "integer",
111  "RatingExt" => "integer",
112  "RatingOverall" => "integer");
113 
114  case "5.1.0":
115  return array(
116  "Id" => "integer",
117  "Title" => "text",
118  "Description" => "text",
119  "StartPage" => "text",
120  "Short" => "text",
121  "Introduction" => "text",
122  "Rating" => "integer",
123  "PublicNotes" => "integer",
124  // "ImpPages" => "integer",
125  "PageToc" => "integer",
126  "RatingSide" => "integer",
127  "RatingNew" => "integer",
128  "RatingExt" => "integer",
129  "RatingOverall" => "integer",
130  "LinkMdValues" => "integer"
131  );
132  }
133  }
134 
135  if ($a_entity == "wpg")
136  {
137  switch ($a_version)
138  {
139  case "4.1.0":
140  return array(
141  "Id" => "integer",
142  "Title" => "text",
143  "WikiId" => "integer");
144 
145  case "4.3.0":
146  case "4.4.0":
147  case "5.1.0":
148  return array(
149  "Id" => "integer",
150  "Title" => "text",
151  "WikiId" => "integer",
152  "Blocked" => "integer",
153  "Rating" => "integer");
154  }
155  }
156 
157  if ($a_entity == "wiki_imp_page")
158  {
159  switch ($a_version)
160  {
161  case "5.1.0":
162  return array(
163  "WikiId" => "integer",
164  "PageId" => "integer",
165  "Ord" => "integer",
166  "Indent" => "integer");
167  }
168  }
169  return array();
170  }
171 
178  function readData($a_entity, $a_version, $a_ids, $a_field = "")
179  {
180  global $ilDB;
181 
182  if (!is_array($a_ids))
183  {
184  $a_ids = array($a_ids);
185  }
186 
187  if ($a_entity == "wiki")
188  {
189  switch ($a_version)
190  {
191  case "4.1.0":
192  $this->getDirectDataFromQuery("SELECT id, title, description,".
193  " startpage start_page, short, rating, introduction".
194  " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)".
195  " WHERE ".$ilDB->in("id", $a_ids, false, "integer"));
196  break;
197 
198  case "4.3.0":
199  $this->getDirectDataFromQuery("SELECT id, title, description,".
200  " startpage start_page, short, rating, introduction,". // imp_pages,
201  " public_notes, page_toc, rating_side, rating_new, rating_ext".
202  " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)".
203  " WHERE ".$ilDB->in("id", $a_ids, false, "integer"));
204  break;
205 
206  case "4.4.0":
207  $this->getDirectDataFromQuery("SELECT id, title, description,".
208  " startpage start_page, short, rating, rating_overall, introduction,". // imp_pages,
209  " public_notes, page_toc, rating_side, rating_new, rating_ext".
210  " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)".
211  " WHERE ".$ilDB->in("id", $a_ids, false, "integer"));
212  break;
213 
214  case "5.1.0":
215  $this->getDirectDataFromQuery("SELECT id, title, description,".
216  " startpage start_page, short, rating, rating_overall, introduction,". // imp_pages,
217  " public_notes, page_toc, rating_side, rating_new, rating_ext, link_md_values".
218  " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)".
219  " WHERE ".$ilDB->in("id", $a_ids, false, "integer"));
220  break;
221  }
222  }
223 
224  if ($a_entity == "wpg")
225  {
226  switch ($a_version)
227  {
228  case "4.1.0":
229  $this->getDirectDataFromQuery("SELECT id, title, wiki_id".
230  " FROM il_wiki_page".
231  " WHERE ".$ilDB->in("wiki_id", $a_ids, false, "integer"));
232  break;
233 
234  case "4.3.0":
235  case "4.4.0":
236  case "5.1.0":
237  $this->getDirectDataFromQuery("SELECT id, title, wiki_id,".
238  " blocked, rating".
239  " FROM il_wiki_page".
240  " WHERE ".$ilDB->in("wiki_id", $a_ids, false, "integer"));
241  break;
242  }
243  }
244 
245  if ($a_entity == "wiki_imp_page")
246  {
247  switch ($a_version)
248  {
249  case "5.1.0":
250  $this->getDirectDataFromQuery("SELECT wiki_id, page_id, ord, indent ".
251  " FROM il_wiki_imp_pages ".
252  " WHERE ".$ilDB->in("wiki_id", $a_ids, false, "integer"));
253  break;
254  }
255  }
256  }
257 
261  protected function getDependencies($a_entity, $a_version, $a_rec, $a_ids)
262  {
263  switch ($a_entity)
264  {
265  case "wiki":
266  return array (
267  "wpg" => array("ids" => $a_rec["Id"]),
268  "wiki_imp_page" => array("ids" => $a_rec["Id"])
269  );
270  }
271 
272  return false;
273  }
274 
275 
282  function importRecord($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
283  {
284 //echo $a_entity;
285 //var_dump($a_rec);
286 
287  switch ($a_entity)
288  {
289  case "wiki":
290 
291  include_once("./Modules/Wiki/classes/class.ilObjWiki.php");
292  if($new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['Id']))
293  {
294  $newObj = ilObjectFactory::getInstanceByObjId($new_id,false);
295  }
296  else
297  {
298  $newObj = new ilObjWiki();
299  $newObj->setType("wiki");
300  $newObj->create(true);
301  }
302 
303  $newObj->setTitle($a_rec["Title"]);
304  $newObj->setDescription($a_rec["Description"]);
305  $newObj->setShortTitle($a_rec["Short"]);
306  $newObj->setStartPage($a_rec["StartPage"]);
307  $newObj->setRatingOverall($a_rec["RatingOverall"]);
308  $newObj->setRating($a_rec["Rating"]);
309  $newObj->setIntroduction($a_rec["Introduction"]);
310  $newObj->setPublicNotes($a_rec["PublicNotes"]);
311 
312  // >= 4.3
313  if(isset($a_rec["PageToc"]))
314  {
315  // $newObj->setImportantPages($a_rec["ImpPages"]);
316  $newObj->setPageToc($a_rec["PageToc"]);
317  $newObj->setRatingAsBlock($a_rec["RatingSide"]);
318  $newObj->setRatingForNewPages($a_rec["RatingNew"]);
319  $newObj->setRatingCategories($a_rec["RatingExt"]);
320  }
321  $newObj->setLinkMetadataValues($a_rec["LinkMdValues"]);
322 
323  $newObj->update(true);
324  $this->current_obj = $newObj;
325  $a_mapping->addMapping("Modules/Wiki", "wiki", $a_rec["Id"], $newObj->getId());
326  $a_mapping->addMapping("Services/Object", "obj", $a_rec["Id"], $newObj->getId());
327  $a_mapping->addMapping("Services/Rating", "rating_category_parent_id", $a_rec["Id"], $newObj->getId());
328  $a_mapping->addMapping("Services/AdvancedMetaData", "parent", $a_rec["Id"], $newObj->getId());
329  break;
330 
331  case "wpg":
332  $wiki_id = $a_mapping->getMapping("Modules/Wiki", "wiki", $a_rec["WikiId"]);
333  include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
334  $wpage = new ilWikiPage();
335  $wpage->setWikiId($wiki_id);
336  $wpage->setTitle($a_rec["Title"]);
337 
338  // >= 4.3
339  if(isset($a_rec["Blocked"]))
340  {
341  $wpage->setBlocked($a_rec["Blocked"]);
342  $wpage->setRating($a_rec["Rating"]);
343  }
344 
345  $wpage->create(true);
346 
347  $a_mapping->addMapping("Modules/Wiki", "wpg", $a_rec["Id"], $wpage->getId());
348  $a_mapping->addMapping("Services/COPage", "pg", "wpg:".$a_rec["Id"], "wpg:".$wpage->getId());
349  $a_mapping->addMapping("Services/AdvancedMetaData", "advmd_sub_item", "advmd:wpg:".$a_rec["Id"], $wpage->getId());
350  break;
351 
352  case "wiki_imp_page":
353  $wiki_id = $a_mapping->getMapping("Modules/Wiki", "wiki", $a_rec["WikiId"]);
354  $page_id = $a_mapping->getMapping("Modules/Wiki", "wpg", $a_rec["PageId"]);
355  if ($wiki_id > 0 && $page_id > 0 && is_object($this->current_obj) && $this->current_obj->getId() == $wiki_id)
356  {
357  $this->current_obj->addImportantPage($page_id, $a_rec["Ord"], $a_rec["Indent"]);
358  }
359  break;
360  }
361  }
362 }
363 ?>
ilWikiDataSet\getSupportedVersions
getSupportedVersions()
Get supported versions.
Definition: class.ilWikiDataSet.php:43
ilWikiDataSet\getXmlNamespace
getXmlNamespace($a_entity, $a_schema_version)
Get xml namespace.
Definition: class.ilWikiDataSet.php:54
ilWikiDataSet\getTypes
getTypes($a_entity, $a_version)
Get field types for entity.
Definition: class.ilWikiDataSet.php:65
ilWikiDataSet\importRecord
importRecord($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
Import record.
Definition: class.ilWikiDataSet.php:282
ilWikiDataSet\__construct
__construct()
construct
Definition: class.ilWikiDataSet.php:30
ilDataSet\getDirectDataFromQuery
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 ...
Definition: class.ilDataSet.php:163
ilObjWiki
Class ilObjWiki.
Definition: class.ilObjWiki.php:20
ilWikiDataSet\getDependencies
getDependencies($a_entity, $a_version, $a_rec, $a_ids)
Determine the dependent sets of data.
Definition: class.ilWikiDataSet.php:261
ilWikiPage
Class ilWikiPage.
Definition: class.ilWikiPage.php:14
ilObjectFactory\getInstanceByObjId
getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:72
ilWikiDataSet
Wiki Data set class.
Definition: class.ilWikiDataSet.php:17
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
ilLoggerFactory\getLogger
static getLogger($a_component_id)
Get component logger.
Definition: class.ilLoggerFactory.php:82
ilDataSet
A dataset contains in data in a common structure that can be shared and transformed for different pur...
Definition: class.ilDataSet.php:24
ilWikiDataSet\readData
readData($a_entity, $a_version, $a_ids, $a_field="")
Read data.
Definition: class.ilWikiDataSet.php:178