ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Data Fields
ilForumXMLWriter Class Reference
Modules/File

XML writer class. More...

+ Inheritance diagram for ilForumXMLWriter:
+ Collaboration diagram for ilForumXMLWriter:

Public Member Functions

 __construct ()
 constructor More...
 
 setForumId ($id)
 
 setFileTargetDirectories ($a_rel, $a_abs)
 Set file target directories. More...
 
 start ()
 
 getXML ()
 
- Public Member Functions inherited from ilXmlWriter
 __construct ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
 constructor More...
 
 _ilXmlWriter ()
 destructor public More...
 
 xmlSetDtdDef ($dtdDef)
 Sets dtd definition. More...
 
 xmlSetStSheet ($stSheet)
 Sets stylesheet. More...
 
 xmlSetGenCmt ($genCmt)
 Sets generated comment. More...
 
 xmlEncodeData ($data)
 Encodes text from input encoding into output encoding. More...
 
 xmlFormatData ($data)
 Indents text for better reading. More...
 
 xmlFormatElement ($array)
 Callback function for xmlFormatData; do not invoke directly. More...
 
 xmlHeader ()
 Writes xml header public. More...
 
 xmlStartTag ($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
 Writes a starttag. More...
 
 xmlEndTag ($tag)
 Writes an endtag. More...
 
 xmlComment ($comment)
 Writes a comment. More...
 
 xmlData ($data, $encode=TRUE, $escape=TRUE)
 Writes data. More...
 
 xmlElement ($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
 Writes a basic element (no children, just textual content) More...
 
 xmlDumpFile ($file, $format=TRUE)
 Dumps xml document from memory into a file. More...
 
 xmlDumpMem ($format=TRUE)
 Returns xml document from memory. More...
 
 appendXML ($a_str)
 append xml string to document More...
 
 xmlClear ()
 clears xmlStr public More...
 

Data Fields

 $forum_id = null
 
- Data Fields inherited from ilXmlWriter
 $xmlStr
 
 $version
 
 $outEnc
 
 $inEnc
 
 $dtdDef = ""
 
 $stSheet = ""
 
 $genCmt = "Generated by ILIAS XmlWriter"
 

Additional Inherited Members

- Static Public Member Functions inherited from ilXmlWriter
static _xmlEscapeData ($data)
 Escapes reserved characters. More...
 

Detailed Description

XML writer class.

Class to simplify manual writing of xml documents. It only supports writing xml sequentially, because the xml document is saved in a string with no additional structure information. The author is responsible for well-formedness and validity of the xml document.

Author
Andreas Kordosz (akord.nosp@m.osz@.nosp@m.datab.nosp@m.ay.d.nosp@m.e)
Version
Id
class.ilExerciseXMLWriter.php,v 1.3 2005/11/04 12:50:24 smeyer Exp

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

Constructor & Destructor Documentation

◆ __construct()

ilForumXMLWriter::__construct ( )

constructor

Parameters
stringxml version
stringoutput encoding
stringinput encoding public

Definition at line 35 of file class.ilForumXMLWriter.php.

36  {
37  parent::__construct();
38  }

Member Function Documentation

◆ getXML()

ilForumXMLWriter::getXML ( )

Definition at line 252 of file class.ilForumXMLWriter.php.

References ilXmlWriter\xmlDumpMem().

253  {
254  // Replace ascii code 11 characters because of problems with xml sax parser
255  return str_replace('', '', $this->xmlDumpMem(false));
256  }
ilXmlWriter\xmlDumpMem
xmlDumpMem($format=TRUE)
Returns xml document from memory.
Definition: class.ilXmlWriter.php:487
+ Here is the call graph for this function:

◆ setFileTargetDirectories()

ilForumXMLWriter::setFileTargetDirectories (   $a_rel,
  $a_abs 
)

Set file target directories.

Parameters
stringrelative file target directory
stringabsolute file target directory

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

54  {
55  $this->target_dir_relative = $a_rel;
56  $this->target_dir_absolute = $a_abs;
57  }

◆ setForumId()

ilForumXMLWriter::setForumId (   $id)

Definition at line 41 of file class.ilForumXMLWriter.php.

42  {
43  $this->forum_id = $id;
44  }

◆ start()

ilForumXMLWriter::start ( )

Definition at line 59 of file class.ilForumXMLWriter.php.

References $file, $ilDB, $mobs, $query, $res, $row, ilObjMediaObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), array, ilDBConstants\FETCHMODE_OBJECT, ilUtil\makeDir(), string, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

60  {
61  global $ilDB;
62 
63  ilUtil::makeDir($this->target_dir_absolute."/objects");
64 
65  $query_frm = 'SELECT * FROM frm_settings fs '.
66  'JOIN object_data od ON fs.obj_id = od.obj_id '.
67  'JOIN frm_data ON top_frm_fk = od.obj_id '.
68  'WHERE fs.obj_id = '.$ilDB->quote($this->forum_id, 'integer');
69 
70  $res = $ilDB->query($query_frm);
71 
72  while( $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT) )
73  {
74  break;
75  }
76 
77  $this->xmlStartTag("Forum", null);
78 
79  $this->xmlElement("Id", null, (int)$row->top_pk);
80  $this->xmlElement("ObjId", null, (int)$row->obj_id);
81  $this->xmlElement("Title", null, $row->title);
82  $this->xmlElement("Description", null, $row->description);
83  $this->xmlElement("DefaultView", null, (int)$row->default_view);
84  $this->xmlElement("Pseudonyms", null, (int)$row->anonymized);
85  $this->xmlElement("Statistics", null, (int)$row->statistics_enabled);
86  $this->xmlElement("ThreadRatings", null, (int)$row->thread_rating);
87  $this->xmlElement("Sorting", null, (int)$row->thread_sorting);
88  $this->xmlElement("MarkModeratorPosts", null, (int)$row->mark_mod_posts);
89  $this->xmlElement("PostingActivation", null, (int)$row->post_activation);
90  $this->xmlElement("PresetSubject", null, (int)$row->preset_subject);
91  $this->xmlElement("PresetRe", null, (int)$row->add_re_subject);
92  $this->xmlElement("NotificationType", null, $row->notification_type);
93  $this->xmlElement("ForceNotification", null, (int)$row->admin_force_noti);
94  $this->xmlElement("ToggleNotification", null, (int)$row->user_toggle_noti);
95  $this->xmlElement("LastPost", null, $row->top_last_post);
96  $this->xmlElement("Moderator", null, (int)$row->top_mods);
97  $this->xmlElement("CreateDate", null, $row->top_date);
98  $this->xmlElement("UpdateDate", null, $row->top_update);
99  $this->xmlElement("FileUpload", null, (int)$row->file_upload_allowed);
100  $this->xmlElement("UpdateUserId", null, $row->update_user);
101  $this->xmlElement("UserId", null, (int)$row->top_usr_id);
102  $this->xmlElement("AuthorId", null, (int)$row->thr_author_id);
103 
104  $query_thr = "SELECT frm_threads.* ".
105  " FROM frm_threads ".
106  " INNER JOIN frm_data ON top_pk = thr_top_fk ".
107  'WHERE top_frm_fk = '.$ilDB->quote($this->forum_id, 'integer');
108 
109  $res = $ilDB->query($query_thr);
110 
111  while( $row = $ilDB->fetchObject($res) )
112  {
113  $this->xmlStartTag("Thread");
114 
115  $this->xmlElement("Id", null, (int)$row->thr_pk);
116  $this->xmlElement("Subject", null, $row->thr_subject);
117  $this->xmlElement("UserId", null, (int)$row->thr_display_user_id);
118  $this->xmlElement("AuthorId", null, (int)$row->thr_author_id);
119  $this->xmlElement("Alias", null, $row->thr_usr_alias);
120  $this->xmlElement("LastPost", null, $row->thr_last_post);
121  $this->xmlElement("CreateDate", null, $row->thr_date);
122  $this->xmlElement("UpdateDate", null, $row->thr_date);
123  $this->xmlElement("ImportName", null, $row->import_name);
124  $this->xmlElement("Sticky", null, (int)$row->is_sticky);
125  $this->xmlElement("Closed", null, (int)$row->is_closed);
126 
127  $query = 'SELECT frm_posts.*, frm_posts_tree.*
128  FROM frm_posts
129  INNER JOIN frm_data
130  ON top_pk = pos_top_fk
131  INNER JOIN frm_posts_tree
132  ON pos_fk = pos_pk
133  WHERE pos_thr_fk = '.$ilDB->quote($row->thr_pk, 'integer').' ';
134  $query .= " ORDER BY frm_posts_tree.lft ASC";
135  $resPosts = $ilDB->query($query);
136 
137  $lastDepth = null;
138  while( $rowPost = $ilDB->fetchObject($resPosts) )
139  {
140  /*
141  // Used for nested postings
142  if( $rowPost->depth < $lastDepth )
143  {
144  for( $i = $rowPost->depth; $i <= $lastDepth; $i++ )
145  {
146  $this->xmlEndTag("Post");
147  }
148  }*/
149 
150  $this->xmlStartTag("Post");
151  $this->xmlElement("Id", null, (int)$rowPost->pos_pk);
152  $this->xmlElement("UserId", null, (int)$rowPost->pos_display_user_id);
153  $this->xmlElement("AuthorId", null, (int)$rowPost->pos_author_id);
154  $this->xmlElement("Alias", null, $rowPost->pos_usr_alias);
155  $this->xmlElement("Subject", null, $rowPost->pos_subject);
156  $this->xmlElement("CreateDate", null, $rowPost->pos_date);
157  $this->xmlElement("UpdateDate", null, $rowPost->pos_update);
158  $this->xmlElement("UpdateUserId", null, (int)$rowPost->update_user);
159  $this->xmlElement("Censorship", null, (int)$rowPost->pos_cens);
160  $this->xmlElement("CensorshipMessage", null, $rowPost->pos_cens_com);
161  $this->xmlElement("Notification", null, $rowPost->notify);
162  $this->xmlElement("ImportName", null, $rowPost->import_name);
163  $this->xmlElement("Status", null, (int)$rowPost->pos_status);
164  $this->xmlElement("Message", null, ilRTE::_replaceMediaObjectImageSrc($rowPost->pos_message, 0));
165 
166  if($rowPost->is_author_moderator === NULL)
167  {
168  $is_moderator_string = 'NULL';
169  }
170  else
171  {
172  $is_moderator_string = (string)$rowPost->is_author_moderator;
173  }
174 
175  $this->xmlElement("isAuthorModerator", null, $is_moderator_string);
176 
177  $media_exists = false;
178  $mobs = ilObjMediaObject::_getMobsOfObject('frm:html', $rowPost->pos_pk);
179  foreach($mobs as $mob)
180  {
181  $moblabel = "il_" . IL_INST_ID . "_mob_" . $mob;
182  if(ilObjMediaObject::_exists($mob))
183  {
184  if(!$media_exists)
185  {
186  $this->xmlStartTag("MessageMediaObjects");
187  $media_exists = true;
188  }
189 
190  $mob_obj = new ilObjMediaObject($mob);
191  $imgattrs = array(
192  "label" => $moblabel,
193  "uri" => $this->target_dir_relative . "/objects/" . "il_" . IL_INST_ID . "_mob_" . $mob . "/" . $mob_obj->getTitle()
194  );
195 
196  $this->xmlElement("MediaObject", $imgattrs, NULL);
197  $mob_obj->exportFiles($this->target_dir_absolute);
198  }
199  }
200  if($media_exists)
201  {
202  $this->xmlEndTag("MessageMediaObjects");
203  }
204 
205  $this->xmlElement("Lft", null, (int)$rowPost->lft);
206  $this->xmlElement("Rgt", null, (int)$rowPost->rgt);
207  $this->xmlElement("Depth", null, (int)$rowPost->depth);
208  $this->xmlElement("ParentId", null, (int)$rowPost->parent_pos);
209 
210  $tmp_file_obj = new ilFileDataForum(
211  $this->forum_id, $rowPost->pos_pk
212  );
213 
214  $set = array();
215  if ( count($tmp_file_obj->getFilesOfPost()) )
216  {
217  foreach ($tmp_file_obj->getFilesOfPost() as $file)
218  {
219  $this->xmlStartTag("Attachment");
220 
221  copy($file['path'], $this->target_dir_absolute."/".basename($file['path']));
222  $content = $this->target_dir_relative."/".basename($file['path']);
223  $this->xmlElement("Content", null, $content);
224 
225  $this->xmlEndTag("Attachment");
226  }
227  }
228 
229  //Used for nested postings
230  //$lastDepth = $rowPost->depth;
231 
232  $this->xmlEndTag("Post");
233  }
234  /*
235  // Used for nested postings
236  if( $lastDepth )
237  {
238  for( $i = 1; $i <= $lastDepth ; $i++ )
239  {
240  $this->xmlEndTag("Post");
241  }
242 
243  $lastDepth = null;
244  }*/
245  $this->xmlEndTag("Thread");
246  }
247  $this->xmlEndTag("Forum");
248 
249  return true;
250  }
ilObjMediaObject\_getMobsOfObject
static _getMobsOfObject($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
get mobs of object
Definition: class.ilObjMediaObject.php:1069
ilObjMediaObject\_exists
static _exists($a_id, $a_reference=false, $a_type=NULL)
checks wether a lm content object with specified id exists or not
Definition: class.ilObjMediaObject.php:84
ilXmlWriter\xmlStartTag
xmlStartTag($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
Writes a starttag.
Definition: class.ilXmlWriter.php:332
ilXmlWriter\xmlElement
xmlElement($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
Writes a basic element (no children, just textual content)
Definition: class.ilXmlWriter.php:423
string
Add rich text string
The name of the decorator.
Definition: 05featuredemo.inc.php:117
ilRTE\_replaceMediaObjectImageSrc
static _replaceMediaObjectImageSrc($a_text, $a_direction=0, $nic=IL_INST_ID)
Replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...
Definition: class.ilRTE.php:237
ilXmlWriter\xmlEndTag
xmlEndTag($tag)
Writes an endtag.
Definition: class.ilXmlWriter.php:375
$mobs
$mobs
Definition: imagemanager.php:71
ilObjMediaObject
Class ilObjMediaObject.
Definition: class.ilObjMediaObject.php:26
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
ilUtil\makeDir
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...
Definition: class.ilUtil.php:2394
ilFileDataForum
This class handles all operations on files for the forum object.
Definition: class.ilFileDataForum.php:15
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
$file
if(!file_exists("$old.txt")) if($old===$new) if(file_exists("$new.txt")) $file
Definition: rename-config.php:43
+ Here is the call graph for this function:

Field Documentation

◆ $forum_id

ilForumXMLWriter::$forum_id = null

Definition at line 26 of file class.ilForumXMLWriter.php.

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