Forum export to HTML and Print. More...

Collaboration diagram for ilForumExportGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	printThread ()

	ensureThreadBelongsToForum (int $objId, \ilForumTopic $thread)

	printPost ()

	exportHTML ()

Data Fields
const	MODE_EXPORT_WEB = 1

const	MODE_EXPORT_CLIENT = 2

	$ctrl

	$lng

	$access

	$error

	$user

	$ilObjDataCache

Protected Member Functions
	prepare ()
	Prepare the export (init MathJax rendering) More...

	renderPostHtml (\ilGlobalTemplate $tpl, ilForumPost $post, $counter, $mode)

Protected Attributes
	$is_moderator = false

	$frm

Detailed Description

Forum export to HTML and Print.

Author: Wolfgang Merkens wmerk.nosp@m.ens@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$

Definition at line 12 of file class.ilForumExportGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilForumExportGUI::__construct ( )

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->error = $DIC['ilErr'];
 
        $this->user = $DIC->user();
        $this->ilObjDataCache = $DIC['ilObjDataCache'];
 
        $forum = new ilObjForum((int) $_GET['ref_id']);
        $this->frm = $forum->Forum;
        $this->objProperties = ilForumProperties::getInstance($forum->getId());
 
        $this->frm->setForumId($forum->getId());
        $this->frm->setForumRefId($forum->getRefId());
 
        $this->lng->loadLanguageModule('forum');
 
        $this->is_moderator = $this->access->checkAccess('moderate_frm', '', (int) $_GET['ref_id']);
    }

References $_GET, $DIC, error(), ilForumProperties\getInstance(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ ensureThreadBelongsToForum()

ilForumExportGUI::ensureThreadBelongsToForum	(	int	$objId,
		\ilForumTopic	$thread
	)

Parameters

int	$objId
ilForumTopic	$thread

Definition at line 128 of file class.ilForumExportGUI.php.

    {
        $forumId = \ilObjForum::lookupForumIdByObjId($objId);
        if ((int) $thread->getForumId() !== (int) $forumId) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
    }

References $objId, error(), ilForumTopic\getForumId(), and ilObjForum\lookupForumIdByObjId().

Referenced by exportHTML(), printPost(), and printThread().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilForumExportGUI::executeCommand ( )

Definition at line 58 of file class.ilForumExportGUI.php.

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            default:
                return $this->$cmd();
                break;
        }
    }

◆ exportHTML()

ilForumExportGUI::exportHTML ( )

Definition at line 330 of file class.ilForumExportGUI.php.

    {
        if (!$this->access->checkAccess('read,visible', '', $_GET['ref_id'])) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        // call prepare to init mathjax rendering
        $this->prepare();
 
        ilDatePresentation::setUseRelativeDates(false);
 
        $tpl = new ilGlobalTemplate('tpl.forums_export_html.html', true, true, 'Modules/Forum');
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        $tpl->setVariable('LOCATION_STYLESHEET', $location_stylesheet);
        $tpl->setVariable('BASE', (substr(ILIAS_HTTP_PATH, -1) == '/' ? ILIAS_HTTP_PATH : ILIAS_HTTP_PATH . '/'));
 
        iljQueryUtil::initjQuery($tpl);
        ilMathJax::getInstance()->includeMathJax($tpl);
 
        $threads = [];
        $isModerator = $this->is_moderator;
        $postIds = (array) $_POST['thread_ids'];
        array_walk($postIds, function ($threadId) use (&$threads, $isModerator) {
            $thread = new \ilForumTopic($threadId, $isModerator);
            $this->ensureThreadBelongsToForum((int) $this->frm->getForumId(), $thread);
 
            $threads[] = $thread;
        });
 
        $j = 0;
        foreach ($threads as $topic) {
            $this->frm->setMDB2WhereCondition('top_pk = %s ', array('integer'), array($topic->getForumId()));
            if (is_array($thread_data = $this->frm->getOneTopic())) {
                if (0 == $j) {
                    $tpl->setVariable('TITLE', $thread_data['top_name']);
                }
 
                $first_post = $topic->getFirstPostNode();
                $topic->setOrderField('frm_posts_tree.rgt');
                $post_collection = $topic->getPostTree($first_post);
 
                $z = 0;
                foreach ($post_collection as $post) {
                    $this->renderPostHtml($tpl, $post, $z++, self::MODE_EXPORT_CLIENT);
                }
 
                $tpl->setCurrentBlock('thread_headline');
                $tpl->setVariable('T_TITLE', $topic->getSubject());
                if ($this->is_moderator) {
                    $tpl->setVariable('T_NUM_POSTS', $topic->countPosts(true));
                } else {
                    $tpl->setVariable('T_NUM_POSTS', $topic->countActivePosts(true));
                }
                $tpl->setVariable('T_NUM_VISITS', $topic->getVisits());
                $tpl->setVariable('T_FORUM', $thread_data['top_name']);
                $authorinfo = new ilForumAuthorInformation(
                    $topic->getThrAuthorId(),
                    $topic->getDisplayUserId(),
                    $topic->getUserAlias(),
                    $topic->getImportName()
                );
                $tpl->setVariable('T_AUTHOR', $authorinfo->getAuthorName());
                $tpl->setVariable('T_TXT_FORUM', $this->lng->txt('forum') . ': ');
                $tpl->setVariable('T_TXT_TOPIC', $this->lng->txt('forums_thread') . ': ');
                $tpl->setVariable('T_TXT_AUTHOR', $this->lng->txt('forums_thread_create_from') . ': ');
                $tpl->setVariable('T_TXT_NUM_POSTS', $this->lng->txt('forums_articles') . ': ');
                $tpl->setVariable('T_TXT_NUM_VISITS', $this->lng->txt('visits') . ': ');
                $tpl->parseCurrentBlock();
 
                ++$j;
            }
 
            $tpl->setCurrentBlock('thread_block');
            $tpl->parseCurrentBlock();
        }
 
        ilUtil::deliverData(
            $tpl->get('DEFAULT', false, false, false, true, false, false),
            'forum_html_export_' . $_GET['ref_id'] . '.html'
        );
    }

References $_GET, $_POST, $is_moderator, $tpl, ilUtil\deliverData(), ensureThreadBelongsToForum(), error(), ilMathJax\getInstance(), ilUtil\getStyleSheetLocation(), ILIAS_HTTP_PATH, iljQueryUtil\initjQuery(), prepare(), renderPostHtml(), and ilDatePresentation\setUseRelativeDates().

Here is the call graph for this function:

◆ prepare()

ilForumExportGUI::prepare ( )

protected

Prepare the export (init MathJax rendering)

Definition at line 117 of file class.ilForumExportGUI.php.

    {
        ilMathJax::getInstance()
            ->init(ilMathJax::PURPOSE_EXPORT)
            ->setZoomFactor(10);
    }

References ilMathJax\getInstance(), and ilMathJax\PURPOSE_EXPORT.

Referenced by exportHTML(), printPost(), and printThread().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printPost()

ilForumExportGUI::printPost ( )

Definition at line 293 of file class.ilForumExportGUI.php.

    {
        if (!$this->access->checkAccess('read,visible', '', $_GET['ref_id'])) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        // call prepare to init mathjax rendering
        $this->prepare();
 
        ilDatePresentation::setUseRelativeDates(false);
 
        $tpl = new ilGlobalTemplate('tpl.forums_export_print.html', true, true, 'Modules/Forum');
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        $tpl->setVariable('LOCATION_STYLESHEET', $location_stylesheet);
 
        iljQueryUtil::initjQuery($tpl);
        ilMathJax::getInstance()->includeMathJax($tpl);
 
        $this->frm->setMDB2WhereCondition('top_pk = %s ', array('integer'), array((int) $_GET['top_pk']));
        if (is_array($frmData = $this->frm->getOneTopic())) {
            $post = new ilForumPost((int) $_GET['print_post'], $this->is_moderator);
            $this->ensureThreadBelongsToForum((int) $this->frm->getForumId(), $post->getThread());
 
            $tpl->setVariable('TITLE', $post->getThread()->getSubject());
            $tpl->setVariable(
                'HEADLINE',
                $this->lng->txt('forum') . ': ' . $frmData['top_name'] . ' > ' . $this->lng->txt('forums_thread') . ': ' . $post->getThread()->getSubject()
            );
 
            $this->renderPostHtml($tpl, $post, 0, self::MODE_EXPORT_WEB);
        }
        $tpl->printToStdout();
    }

References $_GET, $tpl, ensureThreadBelongsToForum(), error(), ilMathJax\getInstance(), ilUtil\getStyleSheetLocation(), iljQueryUtil\initjQuery(), prepare(), renderPostHtml(), and ilDatePresentation\setUseRelativeDates().

Here is the call graph for this function:

◆ printThread()

ilForumExportGUI::printThread ( )

Definition at line 70 of file class.ilForumExportGUI.php.

    {
        if (!$this->access->checkAccess('read,visible', '', (int) $_GET['ref_id'])) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        // fau: call prepare to init mathjax rendering
        $this->prepare();
 
        ilDatePresentation::setUseRelativeDates(false);
 
        $tpl = new ilGlobalTemplate('tpl.forums_export_print.html', true, true, 'Modules/Forum');
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        $tpl->setVariable('LOCATION_STYLESHEET', $location_stylesheet);
 
        iljQueryUtil::initjQuery($tpl);
        ilMathJax::getInstance()->includeMathJax($tpl);
 
        $this->frm->setMDB2WhereCondition('top_pk = %s ', array('integer'), array((int) $_GET['thr_top_fk']));
        if (is_array($frmData = $this->frm->getOneTopic())) {
            $topic = new ilForumTopic(addslashes($_GET['print_thread']), $this->is_moderator);
            $this->ensureThreadBelongsToForum((int) $this->frm->getForumId(), $topic);
 
            $topic->setOrderField('frm_posts_tree.rgt');
            $first_post = $topic->getFirstPostNode();
            $post_collection = $topic->getPostTree($first_post);
            $num_posts = count($post_collection);
 
            $tpl->setVariable('TITLE', $topic->getSubject());
            $tpl->setVariable(
                'HEADLINE',
                $this->lng->txt('forum') . ': ' . $frmData['top_name'] . ' > ' .
                $this->lng->txt('forums_thread') . ': ' . $topic->getSubject() . ' > ' .
                $this->lng->txt('forums_count_art') . ': ' . $num_posts
            );
 
            $z = 0;
            foreach ($post_collection as $post) {
                $this->renderPostHtml($tpl, $post, $z++, self::MODE_EXPORT_WEB);
            }
        }
        $tpl->printToStdout();
    }

References $_GET, $tpl, ensureThreadBelongsToForum(), error(), ilMathJax\getInstance(), ilUtil\getStyleSheetLocation(), iljQueryUtil\initjQuery(), prepare(), renderPostHtml(), and ilDatePresentation\setUseRelativeDates().

Here is the call graph for this function:

◆ renderPostHtml()

ilForumExportGUI::renderPostHtml	(	\ilGlobalTemplate	$tpl,
		ilForumPost	$post,
			$counter,
			$mode
	)

protected

Parameters

\ilGlobalTemplate	$tpl
ilForumPost	$post
int	$counter
int	$mode

Definition at line 142 of file class.ilForumExportGUI.php.

    {
        $tpl->setCurrentBlock('posts_row');
 
        if (ilForumProperties::getInstance($this->ilObjDataCache->lookupObjId($_GET['ref_id']))->getMarkModeratorPosts() == 1) {
            if ($post->getIsAuthorModerator() === null && $is_moderator = ilForum::_isModerator(
                $_GET['ref_id'],
                $post->getPosAuthorId()
            )) {
                $rowCol = 'ilModeratorPosting';
            } else {
                if ($post->getIsAuthorModerator()) {
                    $rowCol = 'ilModeratorPosting';
                } else {
                    $rowCol = ilUtil::switchColor($counter, 'tblrow1', 'tblrow2');
                }
            }
        } else {
            $rowCol = ilUtil::switchColor($counter, 'tblrow1', 'tblrow2');
        }
 
        $tpl->setVariable('ROWCOL', ' ' . $rowCol);
 
        if ($post->isCensored()) {
            $tpl->setVariable('TXT_CENSORSHIP_ADVICE', $this->lng->txt('post_censored_comment_by_moderator'));
            $rowCol = 'tblrowmarked';
        }
 
        $tpl->setVariable('ROWCOL', ' ' . $rowCol);
        if (!$post->isActivated() && $post->isOwner($this->user->getId())) {
            $tpl->setVariable('POST_NOT_ACTIVATED_YET', $this->lng->txt('frm_post_not_activated_yet'));
        }
 
        $authorinfo = new ilForumAuthorInformation(
            $post->getPosAuthorId(),
            $post->getDisplayUserId(),
            $post->getUserAlias(),
            $post->getImportName()
        );
 
        if ($authorinfo->hasSuffix()) {
            if (!$authorinfo->isDeleted()) {
                $tpl->setVariable('USR_NAME', $authorinfo->getAlias());
            }
            $tpl->setVariable('AUTHOR', $authorinfo->getSuffix());
        } else {
            if ($authorinfo->getAuthorName(true) && !$this->objProperties->isAnonymized()) {
                $tpl->setVariable('USR_NAME', $authorinfo->getAuthorName(true));
            }
            $tpl->setVariable('AUTHOR', $authorinfo->getAuthorShortName());
        }
 
        if (self::MODE_EXPORT_CLIENT == $mode) {
            if ($authorinfo->getAuthor()->getPref('public_profile') != 'n') {
                $tpl->setVariable('TXT_REGISTERED', $this->lng->txt('registered_since'));
                $tpl->setVariable(
                    'REGISTERED_SINCE',
                    $this->frm->convertDate($authorinfo->getAuthor()->getCreateDate())
                );
            }
 
            if ($post->getDisplayUserId()) {
                if ($this->is_moderator) {
                    $num_posts = $this->frm->countUserArticles($post->getDisplayUserId());
                } else {
                    $num_posts = $this->frm->countActiveUserArticles($post->getDisplayUserId());
                }
                $tpl->setVariable('TXT_NUM_POSTS', $this->lng->txt('forums_posts'));
                $tpl->setVariable('NUM_POSTS', $num_posts);
            }
        }
 
        $tpl->setVariable('USR_IMAGE', $authorinfo->getProfilePicture());
        if ($authorinfo->getAuthor()->getId() && ilForum::_isModerator(
            (int) $_GET['ref_id'],
            $post->getPosAuthorId()
        )) {
            if ($authorinfo->getAuthor()->getGender() == 'f') {
                $tpl->setVariable('ROLE', $this->lng->txt('frm_moderator_f'));
            } else {
                if ($authorinfo->getAuthor()->getGender() == 'm') {
                    $tpl->setVariable('ROLE', $this->lng->txt('frm_moderator_m'));
                } else {
                    if ($authorinfo->getAuthor()->getGender() == 'n') {
                        $tpl->setVariable('ROLE', $this->lng->txt('frm_moderator_n'));
                    }
                }
            }
        }
 
        // get create- and update-dates
        if ($post->getUpdateUserId() > 0) {
            $spanClass = '';
            if (ilForum::_isModerator((int) $_GET['ref_id'], $post->getUpdateUserId())) {
                $spanClass = 'moderator_small';
            }
 
            $post->setChangeDate($post->getChangeDate());
 
            $authorinfo = new ilForumAuthorInformation(
                $post->getPosAuthorId(),
                $post->getDisplayUserId(),
                $post->getUserAlias(),
                ''
            );
 
            $tpl->setVariable(
                'POST_UPDATE_TXT',
                $this->lng->txt('edited_on') . ': ' . $this->frm->convertDate($post->getChangeDate()) . ' - ' . strtolower($this->lng->txt('by'))
            );
            $tpl->setVariable('UPDATE_AUTHOR', $authorinfo->getLinkedAuthorShortName());
            if ($authorinfo->getAuthorName(true) && !$this->objProperties->isAnonymized()) {
                $tpl->setVariable('UPDATE_USR_NAME', $authorinfo->getAuthorName(true));
            }
        }
 
        // prepare post
        $post->setMessage($this->frm->prepareText($post->getMessage()));
        $tpl->setVariable('POST_DATE', $this->frm->convertDate($post->getCreateDate()));
        $tpl->setVariable('SUBJECT', $post->getSubject());
 
        if (!$post->isCensored()) {
            $spanClass = "";
            if (ilForum::_isModerator((int) $_GET['ref_id'], $post->getDisplayUserId())) {
                $spanClass = 'moderator';
            }
 
            // possible bugfix for mantis #8223
            if ($post->getMessage() == strip_tags($post->getMessage())) {
                // We can be sure, that there are not html tags
                $post->setMessage(nl2br($post->getMessage()));
            }
 
            if ($spanClass != "") {
                $tpl->setVariable(
                    'POST',
                    "<span class=\"" . $spanClass . "\">" . ilRTE::_replaceMediaObjectImageSrc(
                        $post->getMessage(),
                        1
                    ) . "</span>"
                );
            } else {
                $tpl->setVariable('POST', ilRTE::_replaceMediaObjectImageSrc($post->getMessage(), 1));
            }
        } else {
            $tpl->setVariable('POST', "<span class=\"moderator\">" . nl2br($post->getCensorshipComment()) . "</span>");
        }
 
        $tpl->parseCurrentBlock('posts_row');
    }

References $_GET, $is_moderator, $tpl, ilForum\_isModerator(), ilRTE\_replaceMediaObjectImageSrc(), ilForumPost\getCensorshipComment(), ilForumPost\getChangeDate(), ilForumPost\getCreateDate(), ilForumPost\getDisplayUserId(), ilForumPost\getImportName(), ilForumProperties\getInstance(), ilForumPost\getIsAuthorModerator(), ilForumPost\getMessage(), ilForumPost\getPosAuthorId(), ilForumPost\getSubject(), ilForumPost\getUpdateUserId(), ilForumPost\getUserAlias(), ilForumPost\isActivated(), ilForumPost\isCensored(), ilForumPost\isOwner(), ilForumPost\setChangeDate(), ilForumPost\setMessage(), and ilUtil\switchColor().

Referenced by exportHTML(), printPost(), and printThread().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

ilForumExportGUI::$access

Definition at line 18 of file class.ilForumExportGUI.php.

◆ $ctrl

ilForumExportGUI::$ctrl

Definition at line 16 of file class.ilForumExportGUI.php.

◆ $error

ilForumExportGUI::$error

Definition at line 19 of file class.ilForumExportGUI.php.

◆ $frm

ilForumExportGUI::$frm

protected

Definition at line 29 of file class.ilForumExportGUI.php.

◆ $ilObjDataCache

ilForumExportGUI::$ilObjDataCache

Definition at line 21 of file class.ilForumExportGUI.php.

◆ $is_moderator

ilForumExportGUI::$is_moderator = false

protected

Definition at line 25 of file class.ilForumExportGUI.php.

Referenced by exportHTML(), and renderPostHtml().

◆ $lng

ilForumExportGUI::$lng

Definition at line 17 of file class.ilForumExportGUI.php.

◆ $user

ilForumExportGUI::$user

Definition at line 20 of file class.ilForumExportGUI.php.

◆ MODE_EXPORT_CLIENT

const ilForumExportGUI::MODE_EXPORT_CLIENT = 2

Definition at line 15 of file class.ilForumExportGUI.php.

◆ MODE_EXPORT_WEB

const ilForumExportGUI::MODE_EXPORT_WEB = 1

Definition at line 14 of file class.ilForumExportGUI.php.

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

Modules/Forum/classes/class.ilForumExportGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ ensureThreadBelongsToForum()

◆ executeCommand()

◆ exportHTML()

◆ prepare()

◆ printPost()

◆ printThread()

◆ renderPostHtml()

Field Documentation

◆ $access

◆ $ctrl

◆ $error

◆ $frm

◆ $ilObjDataCache

◆ $is_moderator

◆ $lng

◆ $user

◆ MODE_EXPORT_CLIENT

◆ MODE_EXPORT_WEB