ilWikiDataSet Class Reference
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 ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> 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... | |
| stripTags (array $rec, array $omit_keys=[]) | |
Protected Attributes | |
| $wiki_log | |
| Protected Attributes inherited from ilDataSet | |
| $current_installation_id = "" | |
| $db | |
| $ds_log | |
| $ds_namespace = 'ds' | |
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
- Version
- $Id$
Definition at line 17 of file class.ilWikiDataSet.php.
Constructor & Destructor Documentation
◆ __construct()
| ilWikiDataSet::__construct | ( | ) |
construct
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 30 of file class.ilWikiDataSet.php.
31 {
32 global $DIC;
33
34 $this->db = $DIC->database();
35 parent::__construct();
37 }
References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ilLoggerFactory\getLogger().
Here is the call graph for this function:
Member Function Documentation
◆ getDependencies()
|
protected |
Determine the dependent sets of data.
Definition at line 312 of file class.ilWikiDataSet.php.
313 {
314 switch ($a_entity) {
315 case "wiki":
316 return array(
317 "wpg" => array("ids" => $a_rec["Id"]),
318 "wiki_imp_page" => array("ids" => $a_rec["Id"])
319 );
320 }
321
322 return false;
323 }
◆ getSupportedVersions()
| ilWikiDataSet::getSupportedVersions | ( | ) |
Get supported versions.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 46 of file class.ilWikiDataSet.php.
47 {
48 return array("4.1.0", "4.3.0", "4.4.0", "5.1.0", "5.4.0");
49 }
◆ getTypes()
|
protected |
Get field types for entity.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 68 of file class.ilWikiDataSet.php.
69 {
70 if ($a_entity == "wiki") {
71 switch ($a_version) {
72 case "4.1.0":
73 return array(
74 "Id" => "integer",
75 "Title" => "text",
76 "Description" => "text",
77 "StartPage" => "text",
78 "Short" => "text",
79 "Introduction" => "text",
80 "Rating" => "integer");
81
82 case "4.3.0":
83 return array(
84 "Id" => "integer",
85 "Title" => "text",
86 "Description" => "text",
87 "StartPage" => "text",
88 "Short" => "text",
89 "Introduction" => "text",
90 "Rating" => "integer",
91 "PublicNotes" => "integer",
92 // "ImpPages" => "integer",
93 "PageToc" => "integer",
94 "RatingSide" => "integer",
95 "RatingNew" => "integer",
96 "RatingExt" => "integer");
97
98 case "4.4.0":
99 return array(
100 "Id" => "integer",
101 "Title" => "text",
102 "Description" => "text",
103 "StartPage" => "text",
104 "Short" => "text",
105 "Introduction" => "text",
106 "Rating" => "integer",
107 "PublicNotes" => "integer",
108 // "ImpPages" => "integer",
109 "PageToc" => "integer",
110 "RatingSide" => "integer",
111 "RatingNew" => "integer",
112 "RatingExt" => "integer",
113 "RatingOverall" => "integer");
114
115 case "5.1.0":
116 return array(
117 "Id" => "integer",
118 "Title" => "text",
119 "Description" => "text",
120 "StartPage" => "text",
121 "Short" => "text",
122 "Introduction" => "text",
123 "Rating" => "integer",
124 "PublicNotes" => "integer",
125 // "ImpPages" => "integer",
126 "PageToc" => "integer",
127 "RatingSide" => "integer",
128 "RatingNew" => "integer",
129 "RatingExt" => "integer",
130 "RatingOverall" => "integer",
131 "LinkMdValues" => "integer"
132 );
133
134 case "5.4.0":
135 return array(
136 "Id" => "integer",
137 "Title" => "text",
138 "Description" => "text",
139 "StartPage" => "text",
140 "Short" => "text",
141 "Introduction" => "text",
142 "Rating" => "integer",
143 "PublicNotes" => "integer",
144 // "ImpPages" => "integer",
145 "PageToc" => "integer",
146 "RatingSide" => "integer",
147 "RatingNew" => "integer",
148 "RatingExt" => "integer",
149 "RatingOverall" => "integer",
150 "LinkMdValues" => "integer",
151 "EmptyPageTempl" => "integer"
152 );
153 }
154 }
155
156 if ($a_entity == "wpg") {
157 switch ($a_version) {
158 case "4.1.0":
159 return array(
160 "Id" => "integer",
161 "Title" => "text",
162 "WikiId" => "integer");
163
164 case "4.3.0":
165 case "4.4.0":
166 case "5.1.0":
167 return array(
168 "Id" => "integer",
169 "Title" => "text",
170 "WikiId" => "integer",
171 "Blocked" => "integer",
172 "Rating" => "integer");
173
174 case "5.4.0":
175 return array(
176 "Id" => "integer",
177 "Title" => "text",
178 "WikiId" => "integer",
179 "Blocked" => "integer",
180 "Rating" => "integer",
181 "TemplateNewPages" => "integer",
182 "TemplateAddToPage" => "integer"
183 );
184 }
185 }
186
187 if ($a_entity == "wiki_imp_page") {
188 switch ($a_version) {
189 case "5.1.0":
190 case "5.4.0":
191 return array(
192 "WikiId" => "integer",
193 "PageId" => "integer",
194 "Ord" => "integer",
195 "Indent" => "integer");
196 }
197 }
198 return array();
199 }
◆ getXmlNamespace()
| ilWikiDataSet::getXmlNamespace | ( | $a_entity, | |
| $a_schema_version | |||
| ) |
Get xml namespace.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 57 of file class.ilWikiDataSet.php.
58 {
59 return "http://www.ilias.de/xml/Modules/Wiki/" . $a_entity;
60 }
◆ importRecord()
| ilWikiDataSet::importRecord | ( | $a_entity, | |
| $a_types, | |||
| $a_rec, | |||
| $a_mapping, | |||
| $a_schema_version | |||
| ) |
Import record.
- Parameters
-
return
Definition at line 332 of file class.ilWikiDataSet.php.
333 {
334 $a_rec = $this->stripTags($a_rec);
335
336 switch ($a_entity) {
337 case "wiki":
338
339 include_once("./Modules/Wiki/classes/class.ilObjWiki.php");
340 if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
342 } else {
344 $newObj->setType("wiki");
345 $newObj->create(true);
346 }
347
348 $newObj->setTitle($a_rec["Title"]);
349 $newObj->setDescription($a_rec["Description"]);
350 $newObj->setShortTitle($a_rec["Short"]);
351 $newObj->setStartPage($a_rec["StartPage"]);
352 $newObj->setRatingOverall($a_rec["RatingOverall"]);
353 $newObj->setRating($a_rec["Rating"]);
354 $newObj->setIntroduction($a_rec["Introduction"]);
355 $newObj->setPublicNotes($a_rec["PublicNotes"]);
356
357 // >= 4.3
358 if (isset($a_rec["PageToc"])) {
359 // $newObj->setImportantPages($a_rec["ImpPages"]);
360 $newObj->setPageToc($a_rec["PageToc"]);
361 $newObj->setRatingAsBlock($a_rec["RatingSide"]);
362 $newObj->setRatingForNewPages($a_rec["RatingNew"]);
363 $newObj->setRatingCategories($a_rec["RatingExt"]);
364 }
365 $newObj->setLinkMetadataValues($a_rec["LinkMdValues"]);
366 $newObj->setEmptyPageTemplate((int) $a_rec["EmptyPageTempl"]);
367
368 $newObj->update(true);
369 $this->current_obj = $newObj;
370 $a_mapping->addMapping("Modules/Wiki", "wiki", $a_rec["Id"], $newObj->getId());
371 $a_mapping->addMapping("Services/Object", "obj", $a_rec["Id"], $newObj->getId());
372 $a_mapping->addMapping("Services/Rating", "rating_category_parent_id", $a_rec["Id"], $newObj->getId());
373 $a_mapping->addMapping("Services/AdvancedMetaData", "parent", $a_rec["Id"], $newObj->getId());
374 break;
375
376 case "wpg":
377 $wiki_id = $a_mapping->getMapping("Modules/Wiki", "wiki", $a_rec["WikiId"]);
378 include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
380 $wpage->setWikiId($wiki_id);
381 $wpage->setTitle($a_rec["Title"]);
382
383 // >= 4.3
384 if (isset($a_rec["Blocked"])) {
385 $wpage->setBlocked($a_rec["Blocked"]);
386 $wpage->setRating($a_rec["Rating"]);
387 }
388
389 $wpage->create(true);
390
391 if (isset($a_rec["TemplateNewPages"]) || isset($a_rec["TemplateAddToPage"])) {
393 $wtpl->save($wpage->getId(), (int) $a_rec["TemplateNewPages"], (int) $a_rec["TemplateAddToPage"]);
394 }
395
396 $a_mapping->addMapping("Modules/Wiki", "wpg", $a_rec["Id"], $wpage->getId());
397 $a_mapping->addMapping("Services/COPage", "pg", "wpg:" . $a_rec["Id"], "wpg:" . $wpage->getId());
398 $a_mapping->addMapping("Services/AdvancedMetaData", "advmd_sub_item", "advmd:wpg:" . $a_rec["Id"], $wpage->getId());
399 break;
400
401 case "wiki_imp_page":
402 $wiki_id = $a_mapping->getMapping("Modules/Wiki", "wiki", $a_rec["WikiId"]);
403 $page_id = $a_mapping->getMapping("Modules/Wiki", "wpg", $a_rec["PageId"]);
404 if ($wiki_id > 0 && $page_id > 0 && is_object($this->current_obj) && $this->current_obj->getId() == $wiki_id) {
405 $this->current_obj->addImportantPage($page_id, $a_rec["Ord"], $a_rec["Indent"]);
406 }
407 break;
408 }
409 }
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:70
References ilObjectFactory\getInstanceByObjId(), and ilDataSet\stripTags().
Here is the call graph for this function:
◆ readData()
| ilWikiDataSet::readData | ( | $a_entity, | |
| $a_version, | |||
| $a_ids, | |||
$a_field = "" |
|||
| ) |
Read data.
- Parameters
-
return
Definition at line 207 of file class.ilWikiDataSet.php.
208 {
210
211 if (!is_array($a_ids)) {
212 $a_ids = array($a_ids);
213 }
214
215 if ($a_entity == "wiki") {
216 switch ($a_version) {
217 case "4.1.0":
219 " startpage start_page, short, rating, introduction" .
220 " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
222 break;
223
224 case "4.3.0":
226 " startpage start_page, short, rating, introduction," . // imp_pages,
227 " public_notes, page_toc, rating_side, rating_new, rating_ext" .
228 " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
230 break;
231
232 case "4.4.0":
234 " startpage start_page, short, rating, rating_overall, introduction," . // imp_pages,
235 " public_notes, page_toc, rating_side, rating_new, rating_ext" .
236 " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
238 break;
239
240 case "5.1.0":
242 " startpage start_page, short, rating, rating_overall, introduction," . // imp_pages,
243 " public_notes, page_toc, rating_side, rating_new, rating_ext, link_md_values" .
244 " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
246 break;
247
248 case "5.4.0":
250 " startpage start_page, short, rating, rating_overall, introduction," . // imp_pages,
251 " public_notes, page_toc, rating_side, rating_new, rating_ext, link_md_values, empty_page_templ" .
252 " FROM il_wiki_data JOIN object_data ON (il_wiki_data.id = object_data.obj_id)" .
254 break;
255 }
256 }
257
258 if ($a_entity == "wpg") {
259 switch ($a_version) {
260 case "4.1.0":
262 " FROM il_wiki_page" .
264 break;
265
266 case "4.3.0":
267 case "4.4.0":
268 case "5.1.0":
270 " blocked, rating" .
271 " FROM il_wiki_page" .
273 break;
274
275 case "5.4.0":
277 " blocked, rating" .
278 " FROM il_wiki_page" .
280 foreach ($this->data as $k => $v) {
281 $set = $ilDB->queryF(
282 "SELECT * FROM wiki_page_template " .
283 " WHERE wiki_id = %s " .
284 " AND wpage_id = %s ",
285 ["integer", "integer"],
286 [$v["WikiId"], $v["Id"]]
287 );
289 $this->data[$k]["TemplateNewPages"] = $rec["new_pages"];
290 $this->data[$k]["TemplateAddToPage"] = $rec["add_to_page"];
291 }
292 }
293 break;
294 }
295 }
296
297 if ($a_entity == "wiki_imp_page") {
298 switch ($a_version) {
299 case "5.1.0":
300 case "5.4.0":
302 " FROM il_wiki_imp_pages " .
304 break;
305 }
306 }
307 }
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 ...
Definition: class.ilDataSet.php:180
References ilDataSet\$db, $ilDB, and ilDataSet\getDirectDataFromQuery().
Here is the call graph for this function:
Field Documentation
◆ $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
