Public Member Functions |
Static Public Attributes |
Protected Member Functions |
Protected Attributes
ilBlogDataSet Class Reference
Blog Data set class. More...
Inheritance diagram for ilBlogDataSet:
Collaboration diagram for ilBlogDataSet:
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... | |
| getXmlRecord ($a_entity, $a_version, $a_set) | |
| Get xml record. 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... | |
Static Public Attributes | |
| static | $style_map = array() |
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... | |
Protected Attributes | |
| $current_blog | |
| Protected Attributes inherited from ilDataSet | |
| $current_installation_id = "" | |
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
Blog Data set class.
This class implements the following entities:
- blog: object data
- blog_posting: data from table il_blog_posting
- Version
- $Id$
Definition at line 17 of file class.ilBlogDataSet.php.
Member Function Documentation
◆ getDependencies()
|
protected |
Determine the dependent sets of data.
Definition at line 191 of file class.ilBlogDataSet.php.
192 {
193 switch ($a_entity)
194 {
195 case "blog":
196 return array (
197 "blog_posting" => array("ids" => $a_rec["Id"])
198 );
199 }
200 return false;
201 }
◆ getSupportedVersions()
| ilBlogDataSet::getSupportedVersions | ( | ) |
Get supported versions.
Reimplemented from ilDataSet.
Definition at line 26 of file class.ilBlogDataSet.php.
27 {
28 return array("4.3.0", "5.0.0");
29 }
◆ getTypes()
|
protected |
Get field types for entity.
Reimplemented from ilDataSet.
Definition at line 42 of file class.ilBlogDataSet.php.
43 {
44 if ($a_entity == "blog")
45 {
46 switch ($a_version)
47 {
48 case "4.3.0":
49 return array(
50 "Id" => "integer",
51 "Title" => "text",
52 "Description" => "text",
53 "Notes" => "integer",
54 "BgColor" => "text",
55 "FontColor" => "text",
56 "Img" => "text",
57 "Ppic" => "integer",
58 "RssActive" => "integer",
59 "Approval" => "integer",
60 "Dir" => "directory"
61 );
62
63 case "5.0.0":
64 return array(
65 "Id" => "integer",
66 "Title" => "text",
67 "Description" => "text",
68 "Notes" => "integer",
69 "BgColor" => "text",
70 "FontColor" => "text",
71 "Img" => "text",
72 "Ppic" => "integer",
73 "RssActive" => "integer",
74 "Approval" => "integer",
75 "Dir" => "directory",
76 "AbsShorten" => "integer",
77 "AbsShortenLen" => "integer",
78 "AbsImage" => "integer",
79 "AbsImgWidth" => "integer",
80 "AbsImgHeight" => "integer",
81 "NavMode" => "integer",
82 "NavListPost" => "integer",
83 "NavListMon" => "integer",
84 "Keywords" => "integer",
85 "Authors" => "integer",
86 "NavOrder" => "text",
87 "OvPost" => "integer",
88 "Style" => "integer"
89 );
90 }
91 }
92
93 if ($a_entity == "blog_posting")
94 {
95 switch ($a_version)
96 {
97 case "4.3.0":
98 case "5.0.0":
99 return array(
100 "Id" => "integer",
101 "BlogId" => "integer",
102 "Title" => "integer",
103 "Created" => "text",
104 "Author" => "text",
105 "Approved" => "integer"
106 );
107 }
108 }
109 }
◆ getXmlNamespace()
| ilBlogDataSet::getXmlNamespace | ( | $a_entity, | |
| $a_schema_version | |||
| ) |
Get xml namespace.
Reimplemented from ilDataSet.
Definition at line 34 of file class.ilBlogDataSet.php.
35 {
36 return "http://www.ilias.de/xml/Modules/Blog/".$a_entity;
37 }
◆ getXmlRecord()
| ilBlogDataSet::getXmlRecord | ( | $a_entity, | |
| $a_version, | |||
| $a_set | |||
| ) |
Get xml record.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 209 of file class.ilBlogDataSet.php.
210 {
211 if ($a_entity == "blog")
212 {
213 include_once("./Modules/Blog/classes/class.ilObjBlog.php");
215 $a_set["Dir"] = $dir;
216
217 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
219
220 // #14734
221 include_once("./Services/Notes/classes/class.ilNote.php");
223 }
224
225 return $a_set;
226 }
static commentsActivated($a_rep_obj_id, $a_obj_id, $a_obj_type)
Are comments activated for object?
Definition: class.ilNote.php:750
static initStorage($a_id, $a_subdir=null)
Init file system storage.
Definition: class.ilObjBlog.php:368
References ilNote\commentsActivated(), ilObjBlog\initStorage(), and ilObjStyleSheet\lookupObjectStyle().
Here is the call graph for this function:
◆ importRecord()
| ilBlogDataSet::importRecord | ( | $a_entity, | |
| $a_types, | |||
| $a_rec, | |||
| $a_mapping, | |||
| $a_schema_version | |||
| ) |
Import record.
- Parameters
-
return
Definition at line 234 of file class.ilBlogDataSet.php.
235 {
236 switch ($a_entity)
237 {
238 case "blog":
239 include_once("./Modules/Blog/classes/class.ilObjBlog.php");
240
241 // container copy
242 if($new_id = $a_mapping->getMapping("Services/Container", "objs", $a_rec["Id"]))
243 {
245 }
246 else
247 {
249 $newObj->create();
250 }
251
252 $newObj->setTitle($a_rec["Title"]);
253 $newObj->setDescription($a_rec["Description"]);
254 $newObj->setNotesStatus($a_rec["Notes"]);
255 $newObj->setBackgroundColor($a_rec["BgColor"]);
256 $newObj->setFontColor($a_rec["FontColor"]);
257 $newObj->setProfilePicture($a_rec["Ppic"]);
258 $newObj->setRSS($a_rec["RssActive"]);
259 $newObj->setApproval($a_rec["Approval"]);
260 $newObj->setImage($a_rec["Img"]);
261
262 $newObj->setAbstractShorten($a_rec["AbsShorten"]);
263 $newObj->setAbstractShortenLength($a_rec["AbsShortenLen"]);
264 $newObj->setAbstractImage($a_rec["AbsImage"]);
265 $newObj->setAbstractImageWidth($a_rec["AbsImgWidth"]);
266 $newObj->setAbstractImageHeight($a_rec["AbsImgHeight"]);
267 $newObj->setNavMode($a_rec["NavMode"]);
268 $newObj->setNavModeListPostings($a_rec["NavListPost"]);
269 $newObj->setNavModeListMonths($a_rec["NavListMon"]);
270 $newObj->setKeywords($a_rec["Keywords"]);
271 $newObj->setAuthors($a_rec["Authors"]);
272 $newObj->setOrder(trim($a_rec["NavOrder"])
273 ? explode(";", $a_rec["NavOrder"])
274 : null);
275 $newObj->setOverviewPostings($a_rec["OvPost"]);
276
277 $newObj->update();
278
279 // handle image(s)
280 if($a_rec["Img"])
281 {
282 $dir = str_replace("..", "", $a_rec["Dir"]);
284 {
286 $target_dir = ilObjBlog::initStorage($newObj->getId());
287 ilUtil::rCopy($source_dir, $target_dir);
288 }
289 }
290
291 if($a_rec["Style"])
292 {
293 self::$style_map[$a_rec["Style"]][] = $newObj->getId();
294 }
295 $a_mapping->addMapping("Modules/Blog", "blog", $a_rec["Id"], $newObj->getId());
296 break;
297
298 case "blog_posting":
299 $blog_id = (int) $a_mapping->getMapping("Modules/Blog", "blog", $a_rec["BlogId"]);
300 if($blog_id)
301 {
302 include_once("./Modules/Blog/classes/class.ilBlogPosting.php");
304 $newObj->setBlogId($blog_id);
305 $newObj->setTitle($a_rec["Title"]);
307 $newObj->setApproved($a_rec["Approved"]);
308
309 // parse export id into local id (if possible)
311 $newObj->setAuthor($author["id"]);
312
313 $newObj->create(true);
314
315 // keywords
316 $keywords = array();
317 for($loop = 0; $loop < 1000; $loop++)
318 {
319 if(isset($a_rec["Keyword".$loop]))
320 {
321 $keyword = trim($a_rec["Keyword".$loop]);
322 if(strlen($keyword))
323 {
324 $keywords[] = $keyword;
325 }
326 }
327 }
328 if(sizeof($keywords))
329 {
330 $newObj->updateKeywords($keywords);
331 }
332
333 $a_mapping->addMapping("Services/COPage", "pg", "blp:".$a_rec["Id"], "blp:".$newObj->getId());
334 }
335 break;
336 }
337 }
getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:72
static rCopy($a_sdir, $a_tdir, $preserveTimeAttributes=false)
Copies content of a directory $a_sdir recursively to a directory $a_tdir.
Definition: class.ilUtil.php:1572
References ilDataSet\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), IL_CAL_DATETIME, ilObjBlog\initStorage(), ilDataSet\parseObjectExportId(), and ilUtil\rCopy().
Here is the call graph for this function:
◆ readData()
| ilBlogDataSet::readData | ( | $a_entity, | |
| $a_version, | |||
| $a_ids, | |||
$a_field = "" |
|||
| ) |
Read data.
- Parameters
-
return
Definition at line 117 of file class.ilBlogDataSet.php.
118 {
119 global $ilDB;
120
121 if (!is_array($a_ids))
122 {
123 $a_ids = array($a_ids);
124 }
125
126 if ($a_entity == "blog")
127 {
128 switch ($a_version)
129 {
130 case "4.3.0":
132 "bl.notes,bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval".
133 " FROM il_blog bl".
134 " JOIN object_data od ON (od.obj_id = bl.id)".
135 " WHERE ".$ilDB->in("bl.id", $a_ids, false, "integer").
136 " AND od.type = ".$ilDB->quote("blog", "text"));
137 break;
138
139 case "5.0.0":
141 "bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval,".
142 "bl.abs_shorten,bl.abs_shorten_len,bl.abs_image,bl.abs_img_width,bl.abs_img_height,".
143 "bl.nav_mode,bl.nav_list_post,bl.nav_list_mon,bl.keywords,bl.authors,bl.nav_order,".
144 "bl.ov_post".
145 " FROM il_blog bl".
146 " JOIN object_data od ON (od.obj_id = bl.id)".
147 " WHERE ".$ilDB->in("bl.id", $a_ids, false, "integer").
148 " AND od.type = ".$ilDB->quote("blog", "text"));
149 break;
150 }
151 }
152
153 if ($a_entity == "blog_posting")
154 {
155 switch ($a_version)
156 {
157 case "4.3.0":
158 case "5.0.0":
160 " FROM il_blog_posting WHERE ".
161 $ilDB->in("blog_id", $a_ids, false, "integer"));
162 foreach($this->data as $idx => $item)
163 {
164 // create full export id
166 }
167 break;
168 }
169
170 // keywords
171 include_once("./Modules/Blog/classes/class.ilBlogPosting.php");
172 include_once("./Services/MetaData/classes/class.ilMDKeyword.php");
173 foreach($this->data as $idx => $item)
174 {
177 if($keywords)
178 {
179 foreach($keywords as $kidx => $keyword)
180 {
181 $this->data[$idx]["Keyword".$kidx] = $keyword;
182 }
183 }
184 }
185 }
186 }
static getKeywords($a_obj_id, $a_posting_id)
Definition: class.ilBlogPosting.php:471
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, ilDataSet\createObjectExportId(), ilDataSet\getDirectDataFromQuery(), ilBlogPosting\getKeywords(), and ilBlogPosting\lookupBlogId().
Here is the call graph for this function:
Field Documentation
◆ $current_blog
|
protected |
Definition at line 19 of file class.ilBlogDataSet.php.
◆ $style_map
|
static |
Definition at line 21 of file class.ilBlogDataSet.php.
Referenced by ilBlogImporter\finalProcessing().
The documentation for this class was generated from the following file:
- Modules/Blog/classes/class.ilBlogDataSet.php
