ilBookmarkDataSet Class Reference
Bookmarks Data set class. More...
Inheritance diagram for ilBookmarkDataSet:
Collaboration diagram for ilBookmarkDataSet:
Public Member Functions | |
| 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) | |
| 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... | |
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 |
| Protected Attributes inherited from ilDataSet | |
| $current_installation_id = "" | |
Detailed Description
Member Function Documentation
◆ getDependencies()
|
protected |
Determine the dependent sets of data.
Definition at line 127 of file class.ilBookmarkDataSet.php.
128 {
129 switch ($a_entity)
130 {
131 case "bookmarks":
132 return array (
133 "bookmark_tree" => array("ids" => $a_rec["UserId"])
134 );
135 }
136 return false;
137 }
◆ getSupportedVersions()
| ilBookmarkDataSet::getSupportedVersions | ( | ) |
Get supported versions.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 21 of file class.ilBookmarkDataSet.php.
22 {
23 return array("4.3.0");
24 }
◆ getTypes()
|
protected |
Get field types for entity.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 43 of file class.ilBookmarkDataSet.php.
44 {
45 // bookmarks
46 if ($a_entity == "bookmarks")
47 {
48 switch ($a_version)
49 {
50 case "4.3.0":
51 return array(
52 "UserId" => "integer"
53 );
54 }
55 }
56
57 // bookmark_tree
58 if ($a_entity == "bookmark_tree")
59 {
60 switch ($a_version)
61 {
62 case "4.3.0":
63 return array(
64 "UserId" => "integer",
65 "Child" => "integer",
66 "Parent" => "integer",
67 "Depth" => "integer",
68 "Type" => "text",
69 "Title" => "text",
70 "Description" => "text",
71 "Target" => "text"
72 );
73 }
74 }
75 }
◆ getXmlNamespace()
| ilBookmarkDataSet::getXmlNamespace | ( | $a_entity, | |
| $a_schema_version | |||
| ) |
Get xml namespace.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 32 of file class.ilBookmarkDataSet.php.
33 {
34 return "http://www.ilias.de/xml/Services/Bookmarks/".$a_entity;
35 }
◆ importRecord()
| ilBookmarkDataSet::importRecord | ( | $a_entity, | |
| $a_types, | |||
| $a_rec, | |||
| $a_mapping, | |||
| $a_schema_version | |||
| ) |
Import record.
- Parameters
-
return
Definition at line 150 of file class.ilBookmarkDataSet.php.
151 {
152 switch ($a_entity)
153 {
154 case "bookmarks":
155 break;
156
157 case "bookmark_tree":
158 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["UserId"]);
160 {
161//echo "<br><br>";
162//var_dump($a_rec);
163 switch ($a_rec["Type"])
164 {
165 case "bmf":
166 if ($a_rec["Parent"] > 0)
167 {
168 $parent = (int) $a_mapping->getMapping("Services/Bookmarks", "bookmark_tree", $a_rec["Parent"]);
169 include_once("./Services/Bookmarks/classes/class.ilBookmarkFolder.php");
171 $bmf->setTitle($a_rec["Title"]);
172 $bmf->setParent($parent);
173 $bmf->create();
174 $fold_id = $bmf->getId();
175 }
176 else
177 {
179 $tree->setTableNames('bookmark_tree','bookmark_data');
180 $fold_id = $tree->readRootId();
181 }
182 $a_mapping->addMapping("Services/Bookmarks", "bookmark_tree", $a_rec["Child"],
183 $fold_id);
184 break;
185
186 case "bm":
187 $parent = 0;
188 if (((int) $a_rec["Parent"]) > 0)
189 {
190 $parent = (int) $a_mapping->getMapping("Services/Bookmarks", "bookmark_tree", $a_rec["Parent"]);
191 }
192 else
193 {
194 return;
195 }
196
197 if ($parent == 0)
198 {
200 $tree->setTableNames('bookmark_tree','bookmark_data');
201 $parent = $tree->readRootId();
202 }
203//echo "-$parent-";
204 include_once("./Services/Bookmarks/classes/class.ilBookmark.php");
206 $bm->setTitle($a_rec["Title"]);
207 $bm->setDescription($a_rec["Description"]);
208 $bm->setTarget($a_rec["Target"]);
209 $bm->setParent($parent);
210 $bm->create();
211 break;
212
213 }
214 }
215 break;
216 }
217 }
bookmark folder (note: this class handles personal bookmarks folders only)
Definition: class.ilBookmarkFolder.php:15
Tree class data representation in hierachical trees using the Nested Set Model with Gaps by Joe Celco...
Definition: class.ilTree.php:25
References ilObject\_lookupType().
Here is the call graph for this function:
◆ readData()
| ilBookmarkDataSet::readData | ( | $a_entity, | |
| $a_version, | |||
| $a_ids, | |||
$a_field = "" |
|||
| ) |
Read data.
- Parameters
-
return
Definition at line 83 of file class.ilBookmarkDataSet.php.
84 {
85 global $ilDB;
86
87 if (!is_array($a_ids))
88 {
89 $a_ids = array($a_ids);
90 }
91
92 // bookmarks
93 if ($a_entity == "bookmarks")
94 {
95 switch ($a_version)
96 {
97 case "4.3.0":
98 $this->data = array();
99 foreach ($a_ids as $id)
100 {
101 $this->data[] = array("UserId" => $id);
102 }
103 break;
104 }
105 }
106
107 // bookmark_tree
108 if ($a_entity == "bookmark_tree")
109 {
110 switch ($a_version)
111 {
112 case "4.3.0":
114 " ,parent,depth,type,title,description,target ".
115 " FROM bookmark_tree JOIN bookmark_data ON (child = obj_id) ".
116 " WHERE ".
117 $ilDB->in("tree", $a_ids, false, "integer").
118 " ORDER BY tree, depth");
119 break;
120 }
121 }
122 }
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
References $ilDB, and ilDataSet\getDirectDataFromQuery().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- Services/Bookmarks/classes/class.ilBookmarkDataSet.php
