Forum export to HTML and Print. More...

Collaboration diagram for ilForumExportGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	printThread ()

	printPost ()

Data Fields
ilCtrlInterface	$ctrl

ilLanguage	$lng

ilAccessHandler	$access

ilErrorHandling	$error

ilObjUser	$user

ilObjectDataCache	$ilObjDataCache

Protected Member Functions
	renderPostHtml (ilGlobalTemplateInterface $tpl, ilForumPost $post, int $counter, int $mode)

Protected Attributes
bool	$is_moderator = false

ilForum	$frm

Private Member Functions
	retrieveRefId ()

	ensureThreadBelongsToForum (int $objId, ilForumTopic $thread)

	addLatexResources (ilGlobalTemplateInterface $tpl)
	Register the resources needed for latex rendering We can't query these resources from the UI framework in a clean way. More...

Private Attributes
const int	MODE_EXPORT_WEB = 1

const int	MODE_EXPORT_CLIENT = 2

readonly ilForumProperties	$objProperties

readonly GlobalHttpState	$http

readonly Refinery	$refinery

readonly int	$ref_id

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 \

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

Constructor & Destructor Documentation

◆ __construct()

ilForumExportGUI::__construct ( )

Definition at line 47 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'];
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
 
        $this->ref_id = $this->retrieveRefId();
 
        $forum = new ilObjForum($this->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', '', $this->ref_id);
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilForumProperties\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), retrieveRefId(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addLatexResources()

ilForumExportGUI::addLatexResources ( ilGlobalTemplateInterface $tpl )

private

Register the resources needed for latex rendering We can't query these resources from the UI framework in a clean way.

So we have to repeat them here.

See also: \ILIAS\UI\Implementation\Component\Legacy\Renderer::registerResources

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

                                                                      : void
    {
        $tpl->addJavaScript('assets/js/mathjax_config.js');
        $tpl->addJavaScript('node_modules/mathjax/es5/tex-chtml-full.js');
    }

References ILIAS\News\Common\Table\$tpl, and ILIAS\UICore\GlobalTemplate\addJavaScript().

Referenced by printPost(), and printThread().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureThreadBelongsToForum()

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

private

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

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

References $objId, ilForumTopic\getForumId(), ILIAS\Repository\lng(), and ilObjForum\lookupForumIdByObjId().

Referenced by 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 108 of file class.ilForumExportGUI.php.

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        $this->$cmd();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ printPost()

ilForumExportGUI::printPost ( )

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

                               : void
    {
        if (!$this->access->checkAccess('read,visible', '', $this->ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        ilDatePresentation::setUseRelativeDates(false);
 
        $tpl = new ilGlobalTemplate('tpl.forums_export_print.html', true, true, 'components/ILIAS/Forum');
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        $tpl->setVariable('LOCATION_STYLESHEET', $location_stylesheet);
 
        iljQueryUtil::initjQuery($tpl);
        $this->addLatexResources($tpl);
 
        $this->frm->setMDB2WhereCondition('top_pk = %s ', ['integer'], [$this->http->wrapper()->query()->retrieve(
            'top_pk',
            $this->refinery->kindlyTo()->int()
        )]);
        $frmData = $this->frm->getOneTopic();
 
        if ($frmData !== null) {
            $post = new ilForumPost($this->http->wrapper()->query()->retrieve(
                'print_post',
                $this->refinery->kindlyTo()->int()
            ), $this->is_moderator);
            $this->ensureThreadBelongsToForum($this->frm->getForumId(), $post->getThread());
 
            $tpl->setVariable('TITLE', $post->getThread()->getSubject());
            $tpl->setVariable(
                'HEADLINE',
                $this->lng->txt('forum') . ': ' . $frmData->getTopName() . ' > ' .
                    $this->lng->txt('forums_thread') . ': ' . $post->getThread()->getSubject()
            );
 
            $this->renderPostHtml($tpl, $post, 0, self::MODE_EXPORT_WEB);
        }
        $tpl->printToStdout();
    }

References ILIAS\News\Common\Table\$tpl, ILIAS\Repository\access(), addLatexResources(), ensureThreadBelongsToForum(), ilUtil\getStyleSheetLocation(), ILIAS\FileDelivery\http(), iljQueryUtil\initjQuery(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\printToStdout(), renderPostHtml(), ilDatePresentation\setUseRelativeDates(), and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

◆ printThread()

ilForumExportGUI::printThread ( )

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

                                 : void
    {
        if (
            !$this->access->checkAccess('read,visible', '', $this->ref_id) ||
            !$this->http->wrapper()->query()->has('thr_top_fk') ||
            !$this->http->wrapper()->query()->has('print_thread')
        ) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        ilDatePresentation::setUseRelativeDates(false);
 
        $tpl = new ilGlobalTemplate('tpl.forums_export_print.html', true, true, 'components/ILIAS/Forum');
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        $tpl->setVariable('LOCATION_STYLESHEET', $location_stylesheet);
 
        iljQueryUtil::initjQuery($tpl);
        $this->addLatexResources($tpl);
 
        $this->frm->setMDB2WhereCondition('top_pk = %s ', ['integer'], [$this->http->wrapper()->query()->retrieve(
            'thr_top_fk',
            $this->refinery->kindlyTo()->int()
        )]);
        $frmData = $this->frm->getOneTopic();
 
        if ($frmData !== null) {
            $topic = new ilForumTopic($this->http->wrapper()->query()->retrieve(
                'print_thread',
                $this->refinery->kindlyTo()->int()
            ), $this->is_moderator);
 
            $this->ensureThreadBelongsToForum($this->frm->getForumId(), $topic);
 
            $topic->setOrderField('frm_posts_tree.rgt');
            $first_post = $topic->getPostRootNode();
            $post_collection = $topic->getPostTree($first_post);
            $num_posts = count($post_collection);
 
            $tpl->setVariable('TITLE', $topic->getSubject());
            $tpl->setVariable(
                'HEADLINE',
                $this->lng->txt('forum') . ': ' . $frmData->getTopName() . ' > ' .
                $this->lng->txt('forums_thread') . ': ' . $topic->getSubject() . ' > ' .
                $this->lng->txt('forums_count_art') . ': ' . $num_posts
            );
 
            $i = 0;
            foreach ($post_collection as $post) {
                $this->renderPostHtml($tpl, $post, $i++, self::MODE_EXPORT_WEB);
            }
        }
 
        $tpl->printToStdout();
    }

References ILIAS\News\Common\Table\$tpl, ILIAS\Repository\access(), addLatexResources(), ensureThreadBelongsToForum(), ilUtil\getStyleSheetLocation(), ILIAS\FileDelivery\http(), iljQueryUtil\initjQuery(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\printToStdout(), renderPostHtml(), ilDatePresentation\setUseRelativeDates(), and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

◆ renderPostHtml()

ilForumExportGUI::renderPostHtml	(	ilGlobalTemplateInterface	$tpl,
		ilForumPost	$post,
		int	$counter,
		int	$mode
	)

protected

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

                                                                                                                 : void
    {
        $tpl->setCurrentBlock('posts_row');
 
        if (ilForumProperties::getInstance($this->ilObjDataCache->lookupObjId($this->ref_id))->getMarkModeratorPosts()) {
            if ($post->isAuthorModerator() === null && $is_moderator = ilForum::_isModerator(
                $this->ref_id,
                $post->getPosAuthorId()
            )) {
                $rowCol = 'ilModeratorPosting';
            } elseif ($post->isAuthorModerator()) {
                $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(),
            (string) $post->getUserAlias(),
            (string) $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() !== 0) {
                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(
            $this->ref_id,
            $post->getPosAuthorId()
        )) {
            if ($authorinfo->getAuthor()->getGender() === 'f') {
                $tpl->setVariable('ROLE', $this->lng->txt('frm_moderator_f'));
            } elseif ($authorinfo->getAuthor()->getGender() === 'm') {
                $tpl->setVariable('ROLE', $this->lng->txt('frm_moderator_m'));
            } else {
                $tpl->setVariable('ROLE', $this->lng->txt('frm_moderator_n'));
            }
        }
 
        if ($post->getUpdateUserId() > 0) {
            $spanClass = '';
            if (ilForum::_isModerator($this->ref_id, $post->getUpdateUserId())) {
                $spanClass = 'moderator_small';
            }
 
            $post->setChangeDate($post->getChangeDate());
 
            $authorinfo = new ilForumAuthorInformation(
                $post->getPosAuthorId(),
                $post->getDisplayUserId(),
                (string) $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));
            }
        }
 
        $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($this->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((string) $post->getCensorshipComment()) . "</span>");
        }
 
        $tpl->parseCurrentBlock('posts_row');
    }

References $is_moderator, ILIAS\News\Common\Table\$tpl, ilForum\_isModerator(), ilRTE\_replaceMediaObjectImageSrc(), ilForumPost\getCensorshipComment(), ilForumPost\getChangeDate(), ilForumPost\getCreateDate(), ilForumPost\getDisplayUserId(), ilForumPost\getImportName(), ilForumProperties\getInstance(), ilForumPost\getMessage(), ilForumPost\getPosAuthorId(), ilForumPost\getSubject(), ilForumPost\getUpdateUserId(), ilForumPost\getUserAlias(), ilForumPost\isActivated(), ilForumPost\isAuthorModerator(), ilForumPost\isCensored(), ilForumPost\isOwner(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilForumPost\setChangeDate(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ilForumPost\setMessage(), ILIAS\UICore\GlobalTemplate\setVariable(), and ilUtil\switchColor().

Referenced by printPost(), and printThread().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveRefId()

ilForumExportGUI::retrieveRefId ( )

private

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

                                    : int
    {
        $ref_id = 0;
        if ($this->http->wrapper()->query()->has('ref_id')) {
            $ref_id = $this->http->wrapper()->query()->retrieve(
                'ref_id',
                $this->refinery->kindlyTo()->int()
            );
        }
 
        return $ref_id;
    }

References $ref_id, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilForumExportGUI::$access

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

◆ $ctrl

ilCtrlInterface ilForumExportGUI::$ctrl

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

◆ $error

ilErrorHandling ilForumExportGUI::$error

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

◆ $frm

ilForum ilForumExportGUI::$frm

protected

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

◆ $http

readonly GlobalHttpState ilForumExportGUI::$http

private

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

◆ $ilObjDataCache

ilObjectDataCache ilForumExportGUI::$ilObjDataCache

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

◆ $is_moderator

bool ilForumExportGUI::$is_moderator = false

protected

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

Referenced by renderPostHtml().

◆ $lng

ilLanguage ilForumExportGUI::$lng

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

◆ $objProperties

readonly ilForumProperties ilForumExportGUI::$objProperties

private

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

◆ $ref_id

readonly int ilForumExportGUI::$ref_id

private

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

Referenced by retrieveRefId().

◆ $refinery

readonly Refinery ilForumExportGUI::$refinery

private

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

◆ $user

ilObjUser ilForumExportGUI::$user

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

◆ MODE_EXPORT_CLIENT

const int ilForumExportGUI::MODE_EXPORT_CLIENT = 2

private

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

◆ MODE_EXPORT_WEB

const int ilForumExportGUI::MODE_EXPORT_WEB = 1

private

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

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

components/ILIAS/Forum/classes/class.ilForumExportGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLatexResources()

◆ ensureThreadBelongsToForum()

◆ executeCommand()

◆ printPost()

◆ printThread()

◆ renderPostHtml()

◆ retrieveRefId()

Field Documentation

◆ $access

◆ $ctrl

◆ $error

◆ $frm

◆ $http

◆ $ilObjDataCache

◆ $is_moderator

◆ $lng

◆ $objProperties

◆ $ref_id

◆ $refinery

◆ $user

◆ MODE_EXPORT_CLIENT

◆ MODE_EXPORT_WEB