ilForumXMLWriter Class Reference

XML writer class Class to simplify manual writing of xml documents. More...

Inheritance diagram for ilForumXMLWriter:

Collaboration diagram for ilForumXMLWriter:

Public Member Functions
	__construct (string $version='1.0', string $outEnc='utf-8', string $inEnc='utf-8')
	setForumId (int $id)
	setFileTargetDirectories (string $a_rel, string $a_abs)
	getComponentPath ()
	start ()
	getXML ()
Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")
	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...
	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...
	xmlFormatData (string $data)
	Indents text for better reading. More...
	xmlHeader ()
	Writes xml header. More...
	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...
	xmlEndTag (string $tag)
	Writes an endtag. More...
	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...
	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...
	appendXML (string $a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr More...

Data Fields
int	$forum_id = 0

Private Attributes
const	LEGACY_RESOURCE_SUB_DIRECTORY = 'expDir_1'
string	$relative_component_path = null
string	$absolute_root_export_path = null
readonly ILIAS Style Content DomainService	$content_style_domain

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) \

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

Constructor & Destructor Documentation

__construct()

ilForumXMLWriter::__construct	(	string	$version = '1.0',
		string	$outEnc = 'utf-8',
		string	$inEnc = 'utf-8'
	)

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

References $DIC, ilXmlWriter\$inEnc, ilXmlWriter\$outEnc, ilXmlWriter\$version, and ILIAS\GlobalScreen\Provider\__construct().

      {
        global $DIC;

        parent::__construct($version, $outEnc, $inEnc);

        $this->content_style_domain = $DIC
            ->contentStyle()
            ->domain();
    }

Here is the call graph for this function:

Member Function Documentation

getComponentPath()

ilForumXMLWriter::getComponentPath

(

)

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

References $relative_component_path.

Referenced by start().

                                      : string
    {
        return $this->absolute_root_export_path . '/' . $this->relative_component_path;
    }

Here is the caller graph for this function:

getXML()

ilForumXMLWriter::getXML

(

)

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

References ilXmlWriter\xmlDumpMem().

                            : string
    {
        // Replace ascii code 11 characters because of problems with xml sax parser
        return str_replace('', '', $this->xmlDumpMem(false));
    }

Here is the call graph for this function:

setFileTargetDirectories()

ilForumXMLWriter::setFileTargetDirectories	(	string	$a_rel,
		string	$a_abs
	)

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

References $path.

                                                                          : void
    {
        $path = str_replace('\\', '/', $a_rel);
        $segments = explode('/', $path);
        array_shift($segments);
        $a_rel = implode('/', $segments);

        $this->relative_component_path = $a_rel;
        $this->absolute_root_export_path = rtrim($a_abs, '/');
    }

setForumId()

ilForumXMLWriter::setForumId

(

int

$id

)

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

References $id.

                                       : void
    {
        $this->forum_id = $id;
    }

start()

ilForumXMLWriter::start

(

)

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

References $DIC, $ilDB, $res, ilObjMediaObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), getComponentPath(), IL_INST_ID, ilFileUtils\makeDir(), ilFileUtils\makeDirParents(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                           : bool
    {
        global $DIC;
        $ilDB = $DIC->database();

        ilFileUtils::makeDirParents($this->getComponentPath());
        ilFileUtils::makeDir($this->getComponentPath() . '/' . self::LEGACY_RESOURCE_SUB_DIRECTORY);
        ilFileUtils::makeDir($this->getComponentPath() . '/' . self::LEGACY_RESOURCE_SUB_DIRECTORY . '/objects');

        $query_frm = '
            SELECT *
            FROM object_data od
            INNER JOIN frm_data
                ON top_frm_fk  = od.obj_id
            LEFT JOIN frm_settings fs 
                ON fs.obj_id = od.obj_id
            WHERE od.obj_id = ' . $ilDB->quote($this->forum_id, 'integer');

        $res = $ilDB->query($query_frm);
        $row = $ilDB->fetchObject($res);

        $style = $this->content_style_domain->styleForObjId((int) $row->obj_id);
        $attributes = [
            'Style' => $style->getStyleId()
        ];

        $this->xmlStartTag('Forum', $attributes);

        $this->xmlElement('Id', null, (int) $row->top_pk);
        $this->xmlElement('ObjId', null, (int) $row->obj_id);
        $this->xmlElement('Title', null, $row->title);
        $this->xmlElement('Description', null, $row->description);
        $this->xmlElement('DefaultView', null, (int) $row->default_view);
        $this->xmlElement('Pseudonyms', null, (int) $row->anonymized);
        $this->xmlElement('Statistics', null, (int) $row->statistics_enabled);
        $this->xmlElement('ThreadRatings', null, (int) $row->thread_rating);
        $this->xmlElement('MarkModeratorPosts', null, (int) $row->mark_mod_posts);
        $this->xmlElement('PostingActivation', null, (int) $row->post_activation);
        $this->xmlElement('PresetSubject', null, (int) $row->preset_subject);
        $this->xmlElement('PresetRe', null, (int) $row->add_re_subject);
        $this->xmlElement('NotificationType', null, $row->notification_type);
        $this->xmlElement('NotificationEvents', null, (int) $row->interested_events);
        $this->xmlElement('ForceNotification', null, (int) $row->admin_force_noti);
        $this->xmlElement('ToggleNotification', null, (int) $row->user_toggle_noti);
        $this->xmlElement('LastPost', null, $row->top_last_post);
        $this->xmlElement('Moderator', null, (int) $row->top_mods);
        $this->xmlElement('CreateDate', null, $row->top_date);
        $this->xmlElement('UpdateDate', null, $row->top_update);
        $this->xmlElement('FileUpload', null, (int) $row->file_upload_allowed);
        $this->xmlElement('UpdateUserId', null, $row->update_user);
        $this->xmlElement('UserId', null, (int) $row->top_usr_id);

        $query_thr = 'SELECT frm_threads.* ' .
            ' FROM frm_threads ' .
            ' INNER JOIN frm_data ON top_pk = thr_top_fk ' .
            'WHERE top_frm_fk = ' . $ilDB->quote($this->forum_id, 'integer');

        $res = $ilDB->query($query_thr);

        while ($row = $ilDB->fetchObject($res)) {
            $this->xmlStartTag('Thread');

            $this->xmlElement('Id', null, (int) $row->thr_pk);
            $this->xmlElement('Subject', null, $row->thr_subject);
            $this->xmlElement('UserId', null, (int) $row->thr_display_user_id);
            $this->xmlElement('AuthorId', null, (int) $row->thr_author_id);
            $this->xmlElement('Alias', null, $row->thr_usr_alias);
            $this->xmlElement('LastPost', null, $row->thr_last_post);
            $this->xmlElement('CreateDate', null, $row->thr_date);
            $this->xmlElement('UpdateDate', null, $row->thr_date);
            $this->xmlElement('ImportName', null, $row->import_name);
            $this->xmlElement('Sticky', null, (int) $row->is_sticky);
            $this->xmlElement('Closed', null, (int) $row->is_closed);

            $query = 'SELECT frm_posts.*, frm_posts_tree.*
                                                FROM frm_posts
                                                        INNER JOIN frm_data
                                                                ON top_pk = pos_top_fk
                                                        INNER JOIN frm_posts_tree
                                                                ON pos_fk = pos_pk
                                                WHERE pos_thr_fk = ' . $ilDB->quote($row->thr_pk, 'integer') . ' ';
            $query .= ' ORDER BY frm_posts_tree.lft ASC';
            $resPosts = $ilDB->query($query);

            while ($rowPost = $ilDB->fetchObject($resPosts)) {
                $this->xmlStartTag('Post');
                $this->xmlElement('Id', null, (int) $rowPost->pos_pk);
                $this->xmlElement('UserId', null, (int) $rowPost->pos_display_user_id);
                $this->xmlElement('AuthorId', null, (int) $rowPost->pos_author_id);
                $this->xmlElement('Alias', null, $rowPost->pos_usr_alias);
                $this->xmlElement('Subject', null, $rowPost->pos_subject);
                $this->xmlElement('CreateDate', null, $rowPost->pos_date);
                $this->xmlElement('UpdateDate', null, $rowPost->pos_update);
                $this->xmlElement('UpdateUserId', null, (int) $rowPost->update_user);
                $this->xmlElement('Censorship', null, (int) $rowPost->pos_cens);
                $this->xmlElement('CensorshipMessage', null, $rowPost->pos_cens_com);
                $this->xmlElement('Notification', null, $rowPost->notify);
                $this->xmlElement('ImportName', null, $rowPost->import_name);
                $this->xmlElement('Status', null, (int) $rowPost->pos_status);
                $this->xmlElement('Message', null, ilRTE::_replaceMediaObjectImageSrc($rowPost->pos_message, 0));

                if ($rowPost->is_author_moderator === null) {
                    $is_moderator_string = 'NULL';
                } else {
                    $is_moderator_string = (string) $rowPost->is_author_moderator;
                }

                $this->xmlElement('isAuthorModerator', null, $is_moderator_string);

                $media_exists = false;
                $mobs = ilObjMediaObject::_getMobsOfObject('frm:html', (int) $rowPost->pos_pk);
                foreach ($mobs as $mob) {
                    $moblabel = 'il_' . IL_INST_ID . '_mob_' . $mob;
                    if (ilObjMediaObject::_exists($mob)) {
                        if (!$media_exists) {
                            $this->xmlStartTag('MessageMediaObjects');
                            $media_exists = true;
                        }

                        $mob_obj = new ilObjMediaObject($mob);
                        $imgattrs = [
                            'label' => $moblabel,
                            'uri' => $this->relative_component_path . '/' . self::LEGACY_RESOURCE_SUB_DIRECTORY . '/objects/' . 'il_' . IL_INST_ID . '_mob_' . $mob . '/' . $mob_obj->getTitle()
                        ];

                        $this->xmlElement('MediaObject', $imgattrs, null);
                        $mob_obj->exportFiles($this->getComponentPath() . '/' . self::LEGACY_RESOURCE_SUB_DIRECTORY);
                    }
                }
                if ($media_exists) {
                    $this->xmlEndTag('MessageMediaObjects');
                }

                $this->xmlElement('Lft', null, (int) $rowPost->lft);
                $this->xmlElement('Rgt', null, (int) $rowPost->rgt);
                $this->xmlElement('Depth', null, (int) $rowPost->depth);
                $this->xmlElement('ParentId', null, (int) $rowPost->parent_pos);

                $tmp_file_obj = new ilFileDataForum(
                    (int) $this->forum_id,
                    (int) $rowPost->pos_pk
                );

                foreach ($tmp_file_obj->getFilesOfPost() as $file) {
                    $this->xmlStartTag('Attachment');
                    copy($file['path'], $this->getComponentPath() . '/' . self::LEGACY_RESOURCE_SUB_DIRECTORY . '/' . basename($file['name']));
                    $relative_path = $this->relative_component_path . '/' . self::LEGACY_RESOURCE_SUB_DIRECTORY . '/' . basename($file['name']);
                    $this->xmlElement('Content', null, $relative_path);

                    $this->xmlEndTag('Attachment');
                }

                $this->xmlEndTag('Post');
            }
            $this->xmlEndTag('Thread');
        }
        $this->xmlEndTag('Forum');

        return true;
    }

Here is the call graph for this function:

Field Documentation

$absolute_root_export_path

string ilForumXMLWriter::$absolute_root_export_path = null

private

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

$content_style_domain

readonly ILIAS Style Content DomainService ilForumXMLWriter::$content_style_domain

private

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

$forum_id

int ilForumXMLWriter::$forum_id = 0

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

$relative_component_path

string ilForumXMLWriter::$relative_component_path = null

private

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

Referenced by getComponentPath().

LEGACY_RESOURCE_SUB_DIRECTORY

const ilForumXMLWriter::LEGACY_RESOURCE_SUB_DIRECTORY = 'expDir_1'

private

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

---

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

• components/ILIAS/Forum/classes/class.ilForumXMLWriter.php