ilNewsTimelineGUI Class Reference

Timeline for news. More...

Collaboration diagram for ilNewsTimelineGUI:

Public Member Functions
	setUserEditAll (bool $a_val)
	Set user can edit other users postings. More...
	getUserEditAll ()
	Get user can edit other users postings. More...
	executeCommand ()
	show (ilPropertyFormGUI $form=null)
	loadMore ()
	save ()
	update ()
	remove ()

Static Public Member Functions
static	getInstance (int $a_ref_id, bool $a_include_auto_entries)

Protected Member Functions
	__construct (int $a_ref_id, bool $a_include_auto_entries)
	send (string $output)
	updateNewsItem ()
	getEditModal ($form=null)
	getDeleteModal ()

Protected Attributes
ILIAS HTTP Services	$http
int	$news_id
bool	$include_auto_entries
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
int	$ref_id
ilLanguage	$lng
ilToolbarGUI	$toolbar
ilObjUser	$user
ilAccessHandler	$access
bool	$user_edit_all = false
StandardGUIRequest	$std_request

Static Protected Attributes
static int	$items_per_load = 10

Detailed Description

Timeline for news.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilNewsTimelineGUI: ilLikeGUI, ilNoteGUI

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

Constructor & Destructor Documentation

__construct()

ilNewsTimelineGUI::__construct ( int  $a_ref_id, bool  $a_include_auto_entries  )

protected

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\News\StandardGUIRequest\getNewsId(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        $this->ref_id = $a_ref_id;
        $this->lng = $DIC->language();
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->include_auto_entries = $a_include_auto_entries;
        $this->access = $DIC->access();
        $this->http = $DIC->http();

        $this->std_request = new StandardGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );

        $this->news_id = $this->std_request->getNewsId();

        $this->lng->loadLanguageModule("news");
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilNewsTimelineGUI::executeCommand

(

)

Exceptions

ilCtrlException

Definition at line 97 of file class.ilNewsTimelineGUI.php.

References $ctrl, $i, $news_id, ILIAS\Repository\ctrl(), ilCtrl\forwardCommand(), ilCtrl\saveParameter(), and ilNoteGUI\setShowHeader().

                                    : void
    {
        $ctrl = $this->ctrl;

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("show");

        switch ($next_class) {
            case "illikegui":
                $i = new ilNewsItem($this->news_id);
                $likef = new ilLikeFactoryGUI();
                $like_gui = $likef->widget([$i->getContextObjId()]);
                $ctrl->saveParameter($this, "news_id");
                $like_gui->setObject(
                    $i->getContextObjId(),
                    $i->getContextObjType(),
                    $i->getContextSubObjId(),
                    $i->getContextSubObjType(),
                    $this->news_id
                );
                $ret = $ctrl->forwardCommand($like_gui);
                break;

            case "ilnotegui":
                $i = new ilNewsItem($this->news_id);
                $ctrl->saveParameter($this, "news_id");
                $notes_obj_type = ($i->getContextSubObjType() == "")
                    ? $i->getContextObjType()
                    : $i->getContextSubObjType();
                $note_gui = new ilNoteGUI(
                    $i->getContextObjId(),
                    $i->getContextSubObjId(),
                    $notes_obj_type,
                    false,
                    $i->getId()
                );
                $note_gui->setShowHeader(false);
                $ret = $ctrl->forwardCommand($note_gui);
                break;

            default:
                if (in_array($cmd, ["show", "save", "update", "loadMore", "remove", "updateNewsItem"])) {
                    $this->$cmd();
                }
        }
    }

Here is the call graph for this function:

getDeleteModal()

ilNewsTimelineGUI::getDeleteModal ( )

protected

Definition at line 432 of file class.ilNewsTimelineGUI.php.

References ilSubmitButton\getInstance(), ilModalGUI\getInstance(), ilUtil\getSystemMessageHTML(), ILIAS\Repository\lng(), and ilModalGUI\TYPE_LARGE.

Referenced by show().

                                       : string
    {
        $modal = ilModalGUI::getInstance();
        $modal->setHeading($this->lng->txt("delete"));
        $modal->setId("ilNewsDeleteModal");
        $modal->setType(ilModalGUI::TYPE_LARGE);

        $confirm = ilSubmitButton::getInstance();
        $confirm->setCaption("delete");
        $confirm->setId("news_btn_delete");
        $modal->addButton($confirm);

        $cancel = ilSubmitButton::getInstance();
        $cancel->setCaption("cancel");
        $cancel->setId("news_btn_cancel_delete");
        $modal->addButton($cancel);

        $modal->setBody("<p id='news_delete_news_title'></p>" .
            ilUtil::getSystemMessageHTML($this->lng->txt("news_really_delete_news"), "question"));

        return $modal->getHTML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEditModal()

ilNewsTimelineGUI::getEditModal (   $form = null )

protected

Definition at line 406 of file class.ilNewsTimelineGUI.php.

References ILIAS\Repository\ctrl(), ilNewsItemGUI\FORM_EDIT, ilNewsItemGUI\getEditForm(), ilModalGUI\getInstance(), ILIAS\Repository\lng(), and ilModalGUI\TYPE_LARGE.

Referenced by show().

                                                 : string
    {
        $modal = ilModalGUI::getInstance();
        $modal->setHeading($this->lng->txt("edit"));
        $modal->setId("ilNewsEditModal");
        $modal->setType(ilModalGUI::TYPE_LARGE);

        if (is_null($form)) {
            $form = ilNewsItemGUI::getEditForm(ilNewsItemGUI::FORM_EDIT, $this->ref_id);
        }
        $form->setShowTopButtons(false);
        $form->setFormAction($this->ctrl->getFormAction($this));


        //
        $hi = new ilHiddenInputGUI("id");
        $form->addItem($hi);
        $act = new ilHiddenInputGUI("news_action");
        $form->addItem($act);
        $form->setId("news_edit_form");

        $modal->setBody($form->getHTML());

        return $modal->getHTML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilNewsTimelineGUI::getInstance ( int  $a_ref_id, bool  $a_include_auto_entries  )

static

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

Referenced by ilObjGroupGUI\executeCommand(), and ilObjCourseGUI\executeCommand().

     : ilNewsTimelineGUI {
        return new self($a_ref_id, $a_include_auto_entries);
    }

Here is the caller graph for this function:

getUserEditAll()

ilNewsTimelineGUI::getUserEditAll

(

)

Get user can edit other users postings.

Definition at line 82 of file class.ilNewsTimelineGUI.php.

References $user_edit_all.

Referenced by loadMore(), remove(), and show().

                                    : bool
    {
        return $this->user_edit_all;
    }

Here is the caller graph for this function:

loadMore()

ilNewsTimelineGUI::loadMore

(

)

Definition at line 224 of file class.ilNewsTimelineGUI.php.

References Vendor\Package\$a, $d, ILIAS\Repository\ctrl(), ilTimelineGUI\getInstance(), ilNewsTimelineItemGUI\getInstance(), getUserEditAll(), and send().

                              : void
    {
        $news_item = new ilNewsItem();
        $news_item->setContextObjId($this->ctrl->getContextObjId());
        $news_item->setContextObjType($this->ctrl->getContextObjType());

        $excluded = $this->std_request->getRenderedNews();

        $news_data = $news_item->getNewsForRefId(
            $this->ref_id,
            false,
            false,
            0,
            true,
            false,
            !$this->include_auto_entries,
            false,
            null,
            self::$items_per_load,
            $excluded
        );

        $timeline = ilTimelineGUI::getInstance();

        // get like widget
        $obj_ids = array_unique(array_map(static function ($a): int {
            return (int) $a["context_obj_id"];
        }, $news_data));
        $likef = new ilLikeFactoryGUI();
        $like_gui = $likef->widget($obj_ids);

        $js_items = [];
        foreach ($news_data as $d) {
            $news_item = new ilNewsItem((int) $d["id"]);
            $item = ilNewsTimelineItemGUI::getInstance($news_item, (int) $d["ref_id"], $like_gui);
            $item->setUserEditAll($this->getUserEditAll());
            $timeline->addItem($item);
            $js_items[$d["id"]] = [
                "id" => $d["id"],
                "user_id" => $d["user_id"],
                "title" => $d["title"],
                "content" => $d["content"] . $d["content_long"],
                "content_long" => "",
                "priority" => $d["priority"],
                "visibility" => $d["visibility"],
                "content_type" => $d["content_type"],
                "mob_id" => $d["mob_id"]
            ];
        }

        $obj = new stdClass();
        $obj->data = $js_items;
        $obj->html = $timeline->render(true);

        $this->send(json_encode($obj, JSON_THROW_ON_ERROR));
    }

Here is the call graph for this function:

remove()

ilNewsTimelineGUI::remove

(

)

Definition at line 397 of file class.ilNewsTimelineGUI.php.

References ilNewsItem\delete(), getUserEditAll(), send(), and ILIAS\Repository\user().

                            : void
    {
        $news_item = new ilNewsItem($this->std_request->getNewsId());
        if ($this->getUserEditAll() || $this->user->getId() === $news_item->getUserId()) {
            $news_item->delete();
        }
        $this->send("");
    }

Here is the call graph for this function:

save()

ilNewsTimelineGUI::save

(

)

Definition at line 305 of file class.ilNewsTimelineGUI.php.

References ilObject\_lookupObjectId(), ilObject\_lookupType(), ilObjMediaObject\_saveTempFileAsMediaObject(), ILIAS\Repository\ctrl(), ilNewsItemGUI\FORM_EDIT, ilNewsItemGUI\getEditForm(), ilNewsItemGUI\isRteActivated(), show(), and ILIAS\Repository\user().

Referenced by updateNewsItem().

                          : void
    {
        $form = ilNewsItemGUI::getEditForm(ilNewsItemGUI::FORM_EDIT, $this->ref_id);
        if ($form->checkInput()) {
            $news_item = new ilNewsItem();
            $news_item->setTitle($form->getInput("news_title"));
            $news_item->setContent($form->getInput("news_content"));
            $news_item->setVisibility($form->getInput("news_visibility"));
            if (ilNewsItemGUI::isRteActivated()) {
                $news_item->setContentHtml(true);
            }
            //$news_item->setContentLong($form->getInput("news_content_long"));
            $news_item->setContentLong("");

            $obj_id = ilObject::_lookupObjectId($this->ref_id);
            $obj_type = ilObject::_lookupType($obj_id);
            $news_item->setContextObjId($obj_id);
            $news_item->setContextObjType($obj_type);
            $news_item->setUserId($this->user->getId());

            $media = $_FILES["media"];
            if ($media["name"] != "") {
                $mob = ilObjMediaObject::_saveTempFileAsMediaObject($media["name"], $media["tmp_name"], true);
                $news_item->setMobId($mob->getId());
            }

            $news_set = new ilSetting("news");
            if (!$news_set->get("enable_rss_for_internal")) {
                $news_item->setVisibility("users");
            }
            $news_item->create();
            $this->ctrl->redirect($this, "show");
        } else {
            $form->setValuesByPost();
            $this->show($form);
            $this->tpl->addOnLoadCode("il.News.create(true);");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilNewsTimelineGUI::send ( string  $output )

protected

Exceptions

ResponseSendingException

Definition at line 284 of file class.ilNewsTimelineGUI.php.

References ILIAS\FileDelivery\http().

Referenced by loadMore(), and remove().

                                           : void
    {
        $this->http->saveResponse($this->http->response()->withBody(
            Streams::ofString($output)
        ));
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUserEditAll()

ilNewsTimelineGUI::setUserEditAll

(

bool

$a_val

)

Set user can edit other users postings.

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

                                               : void
    {
        $this->user_edit_all = $a_val;
    }

show()

ilNewsTimelineGUI::show

(

ilPropertyFormGUI

$form = null

)

Definition at line 144 of file class.ilNewsTimelineGUI.php.

References Vendor\Package\$a, Vendor\Package\$b, $d, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getDeleteModal(), getEditModal(), ilUtil\getImagePath(), ilLinkButton\getInstance(), ilTimelineGUI\getInstance(), ilNewsTimelineItemGUI\getInstance(), getUserEditAll(), ilMediaPlayerGUI\initJavascript(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by save(), and update().

                                                        : void
    {
        // toolbar
        if ($this->access->checkAccess("news_add_news", "", $this->ref_id)) {
            $b = ilLinkButton::getInstance();
            $b->setCaption('news_add_news');
            $b->setOnClick("return il.News.create();");
            $b->setPrimary(true);
            $this->toolbar->addButtonInstance($b);
        }

        $news_item = new ilNewsItem();
        $news_item->setContextObjId($this->ctrl->getContextObjId());
        $news_item->setContextObjType($this->ctrl->getContextObjType());

        $news_data = $news_item->getNewsForRefId(
            $this->ref_id,
            false,
            false,
            0,
            true,
            false,
            !$this->include_auto_entries,
            false,
            null,
            self::$items_per_load
        );

        $timeline = ilTimelineGUI::getInstance();

        // get like widget
        $obj_ids = array_unique(array_map(static function (array $a): int {
            return (int) $a["context_obj_id"];
        }, $news_data));
        $likef = new ilLikeFactoryGUI();
        $like_gui = $likef->widget($obj_ids);

        $js_items = [];
        foreach ($news_data as $d) {
            $news_item = new ilNewsItem((int) $d["id"]);
            $item = ilNewsTimelineItemGUI::getInstance($news_item, (int) $d["ref_id"], $like_gui);
            $item->setUserEditAll($this->getUserEditAll());
            $timeline->addItem($item);
            $js_items[$d["id"]] = [
                "id" => $d["id"],
                "user_id" => $d["user_id"],
                "title" => $d["title"],
                "content" => $d["content"] . $d["content_long"],
                "content_long" => "",
                "priority" => $d["priority"],
                "visibility" => $d["visibility"],
                "content_type" => $d["content_type"],
                "mob_id" => $d["mob_id"]
            ];
        }

        $this->tpl->addOnLoadCode("il.News.setItems(" . json_encode($js_items, JSON_THROW_ON_ERROR) . ");");
        $this->tpl->addOnLoadCode("il.News.setAjaxUrl('" . $this->ctrl->getLinkTarget($this, "", "", true) . "');");

        if (count($news_data) > 0) {
            $ttpl = new ilTemplate("tpl.news_timeline.html", true, true, "Services/News");
            $ttpl->setVariable("NEWS", $timeline->render());
            $ttpl->setVariable("EDIT_MODAL", $this->getEditModal($form));
            $ttpl->setVariable("DELETE_MODAL", $this->getDeleteModal());
            $ttpl->setVariable("LOADER", ilUtil::getImagePath("loader.svg"));
            $this->tpl->setContent($ttpl->get());
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("news_timline_add_entries_info"));
            $this->tpl->setContent($this->getEditModal());
        }

        $this->lng->toJS("create");
        $this->lng->toJS("edit");
        $this->lng->toJS("update");
        $this->lng->toJS("save");

        $this->tpl->addJavaScript("./Services/News/js/News.js");
        ilMediaPlayerGUI::initJavascript($this->tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilNewsTimelineGUI::update

(

)

Definition at line 347 of file class.ilNewsTimelineGUI.php.

References ilObject\_lookupObjectId(), ilObject\_lookupType(), ilObjMediaObject\_saveTempFileAsMediaObject(), ILIAS\Repository\ctrl(), ilNewsItemGUI\FORM_EDIT, ilNewsItemGUI\getEditForm(), ilNewsItemGUI\isRteActivated(), ilNewsItem\setTitle(), show(), and ILIAS\Repository\user().

Referenced by updateNewsItem().

                            : void
    {
        $form = ilNewsItemGUI::getEditForm(ilNewsItemGUI::FORM_EDIT, $this->ref_id);
        if ($form->checkInput()) {
            $news_item = new ilNewsItem($this->std_request->getId());
            $news_item->setTitle($form->getInput("news_title"));
            $news_item->setContent($form->getInput("news_content"));
            $news_item->setVisibility($form->getInput("news_visibility"));
            //$news_item->setContentLong($form->getInput("news_content_long"));
            if (ilNewsItemGUI::isRteActivated()) {
                $news_item->setContentHtml(true);
            }
            $news_item->setContentLong("");

            $media = $_FILES["media"];
            $old_mob_id = 0;

            // delete old media object
            if ($media["name"] != "" || $this->std_request->getDeleteMedia() > 0) {
                if ($news_item->getMobId() > 0 && ilObject::_lookupType($news_item->getMobId()) === "mob") {
                    $old_mob_id = $news_item->getMobId();
                }
                $news_item->setMobId(0);
            }

            if ($media["name"] != "") {
                $mob = ilObjMediaObject::_saveTempFileAsMediaObject($media["name"], $media["tmp_name"], true);
                $news_item->setMobId($mob->getId());
            }

            $obj_id = ilObject::_lookupObjectId($this->ref_id);

            if ($news_item->getContextObjId() === $obj_id) {
                $news_item->setUpdateUserId($this->user->getId());
                $news_item->update();

                if ($old_mob_id > 0) {
                    $old_mob = new ilObjMediaObject($old_mob_id);
                    $old_mob->delete();
                }
            }
            $this->ctrl->redirect($this, "show");
        } else {
            $form->setValuesByPost();
            $this->show($form);
            $this->tpl->addOnLoadCode("il.News.edit(" . $this->std_request->getNewsId() . ", true);");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateNewsItem()

ilNewsTimelineGUI::updateNewsItem ( )

protected

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

References save(), and update().

                                       : void
    {
        if ($this->std_request->getNewsAction() === "save") {
            $this->save();
        }
        if ($this->std_request->getNewsAction() === "update") {
            $this->update();
        }
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilNewsTimelineGUI::$access

protected

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

$ctrl

ilCtrl ilNewsTimelineGUI::$ctrl

protected

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

Referenced by executeCommand().

$http

ILIAS HTTP Services ilNewsTimelineGUI::$http

protected

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

$include_auto_entries

bool ilNewsTimelineGUI::$include_auto_entries

protected

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

$items_per_load

int ilNewsTimelineGUI::$items_per_load = 10

staticprotected

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

$lng

ilLanguage ilNewsTimelineGUI::$lng

protected

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

$news_id

int ilNewsTimelineGUI::$news_id

protected

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

Referenced by executeCommand().

$ref_id

int ilNewsTimelineGUI::$ref_id

protected

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

$std_request

StandardGUIRequest ilNewsTimelineGUI::$std_request

protected

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

$toolbar

ilToolbarGUI ilNewsTimelineGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilNewsTimelineGUI::$tpl

protected

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

$user

ilObjUser ilNewsTimelineGUI::$user

protected

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

$user_edit_all

bool ilNewsTimelineGUI::$user_edit_all = false

protected

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

Referenced by getUserEditAll().

---

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

• Services/News/classes/class.ilNewsTimelineGUI.php