Timeline for news. More...

Collaboration diagram for ilNewsTimelineGUI:

Public Member Functions
	setEnableAddNews (bool $a_val)

	getEnableAddNews ()

	setPeriod (int $a_val)

	getPeriod ()

	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)

	getHTML (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)

	readNewsData ($excluded=[])

	send (string $output)

	updateNewsItem ()

	getEditModal ($form=null)

	renderDeleteModal (ilTemplate $tpl)

	renderEditModal (?ilPropertyFormGUI $form, ilTemplate $tpl)

	downloadMob ()

Protected Attributes
ILIAS News InternalGUIService	$gui

int	$period = 0

ILIAS News Timeline TimelineManager	$manager

ILIAS DI UIServices	$ui

ILIAS Notes Service	$notes

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

bool	$enable_add_news = true

array	$news_data = null

Static Protected Attributes
static int	$items_per_load = 20

Detailed Description

Timeline for news.

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

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 52 of file class.ilNewsTimelineGUI.php.

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), 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->notes = $DIC->notes();
 
         $this->std_request = $DIC->news()
             ->internal()
             ->gui()
             ->standardRequest();
 
         $this->news_id = $this->std_request->getNewsId();
 
         $this->lng->loadLanguageModule("news");
         $this->lng->loadLanguageModule("cont");
         $this->ui = $DIC->ui();
         $this->manager = $DIC->news()->internal()->domain()->timeline();
         $this->gui = $DIC->news()->internal()->gui();
     }

Here is the call graph for this function:

Member Function Documentation

◆ downloadMob()

ilNewsTimelineGUI::downloadMob ( )

protected

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

                                     : void
     {
         $news_id = $this->std_request->getNewsId();
         $news = new ilNewsItem($news_id);
         $news->deliverMobFile("Standard", true);
     }

◆ executeCommand()

ilNewsTimelineGUI::executeCommand ( )

Exceptions

ilCtrlException

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

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

                                     : 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 strtolower(ilCommentGUI::class):
                 $i = new ilNewsItem($this->news_id);
                 $ctrl->saveParameter($this, "news_id");
                 $notes_obj_type = ($i->getContextSubObjType() == "")
                     ? $i->getContextObjType()
                     : $i->getContextSubObjType();
                 $comment_gui = $this->notes->gui()->getCommentsGUI(
                     $i->getContextObjId(),
                     $i->getContextSubObjId(),
                     $notes_obj_type,
                     $i->getId()
                 );
                 $comment_gui->setShowHeader(false);
                 $ret = $ctrl->forwardCommand($comment_gui);
                 break;
 
             default:
                 if (in_array($cmd, ["show", "save", "update", "loadMore", "remove", "updateNewsItem", "downloadMob"])) {
                     $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ getEditModal()

ilNewsTimelineGUI::getEditModal ( $form = null )

protected

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

References ILIAS\Repository\ctrl(), ilNewsItemGUI\FORM_EDIT, ilNewsItemGUI\getEditForm(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by renderEditModal().

                                                  : \ILIAS\UI\Component\Modal\Modal
     {
         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 = $this->gui->ui()->factory()->modal()->roundtrip(
             $this->lng->txt("edit"),
             $this->ui->factory()->legacy($form->getHTML())
         );
 
         return $modal;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEnableAddNews()

ilNewsTimelineGUI::getEnableAddNews ( )

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

References $enable_add_news.

Referenced by getHTML().

                                       : bool
     {
         return $this->enable_add_news;
     }

Here is the caller graph for this function:

◆ getHTML()

ilNewsTimelineGUI::getHTML ( ilPropertyFormGUI $form = null )

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

References Vendor\Package\$a, Vendor\Package\$d, $news_data, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getEnableAddNews(), ilUtil\getImagePath(), ilTimelineGUI\getInstance(), ilNewsTimelineItemGUI\getInstance(), getUserEditAll(), ILIAS\Repository\lng(), readNewsData(), renderDeleteModal(), renderEditModal(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Referenced by show().

                                                            : string
     {
         // toolbar
         if ($this->getEnableAddNews() &&
             $this->access->checkAccess("news_add_news", "", $this->ref_id)) {
             $this->gui->button(
                 $this->lng->txt("news_add_news"),
                 "#"
             )->onClick("return il.News.create();")->primary()->toToolbar(true, $this->toolbar);
         }
 
         $this->readNewsData();
 
         $timeline = ilTimelineGUI::getInstance();
 
         // get like widget
         $obj_ids = array_unique(array_map(static function (array $a): int {
             return (int) $a["context_obj_id"];
         }, $this->news_data));
         $likef = new ilLikeFactoryGUI();
         $like_gui = $likef->widget($obj_ids);
 
         $js_items = [];
         foreach ($this->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($this->news_data) > 0) {
             $ttpl = new ilTemplate("tpl.news_timeline.html", true, true, "components/ILIAS/News");
             $ttpl->setVariable("NEWS", $timeline->render());
             $this->renderDeleteModal($ttpl);
             $this->renderEditModal($form, $ttpl);
             $ttpl->setVariable("LOADER", ilUtil::getImagePath("media/loader.svg"));
             $this->tpl->setContent($ttpl->get());
             $html = $ttpl->get();
         } else {
             if ($this->getEnableAddNews()) {
                 $ttpl = new ilTemplate("tpl.news_timeline.html", true, true, "components/ILIAS/News");
                 $this->tpl->setOnScreenMessage('info', $this->lng->txt("news_timline_add_entries_info"));
                 $this->renderEditModal($form, $ttpl);
                 $this->tpl->setContent($ttpl->get());
                 $html = $ttpl->get();
             } else {
                 $mess = $this->ui->factory()->messageBox()->info(
                     $this->lng->txt("news_timline_no_entries")
                 );
                 $html = $this->ui->renderer()->render($mess);
             }
         }
 
         $this->lng->toJS("create");
         $this->lng->toJS("edit");
         $this->lng->toJS("update");
         $this->lng->toJS("save");
 
         $debug = false;
         if ($debug) {
             $this->tpl->addJavaScript("../components/ILIAS/News/resources/News.js");
         } else {
             $this->tpl->addJavaScript("assets/js/News.js");
         }
         $this->notes->gui()->initJavascript();
         return $html;
     }

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 120 of file class.ilNewsTimelineGUI.php.

Referenced by ilObjGroupGUI\executeCommand(), ilObjCourseGUI\executeCommand(), and ILIAS\News\Dashboard\InternalGUIService\getTimelineGUI().

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

Here is the caller graph for this function:

◆ getPeriod()

ilNewsTimelineGUI::getPeriod ( )

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

References $period.

                                : int
     {
         return $this->period;
     }

◆ getUserEditAll()

ilNewsTimelineGUI::getUserEditAll ( )

Get user can edit other users postings.

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

References $user_edit_all.

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

                                     : bool
     {
         return $this->user_edit_all;
     }

Here is the caller graph for this function:

◆ loadMore()

ilNewsTimelineGUI::loadMore ( )

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

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

                               : void
     {
         $news_item = new ilNewsItem();
         $news_item->setContextObjId($this->ctrl->getContextObjId());
         $news_item->setContextObjType($this->ctrl->getContextObjType());
 
         $excluded = $this->std_request->getRenderedNews();
 
         $this->readNewsData($excluded);
 
         $timeline = ilTimelineGUI::getInstance();
 
         // get like widget
         $obj_ids = array_unique(array_map(static function ($a): int {
             return (int) $a["context_obj_id"];
         }, $this->news_data));
         $likef = new ilLikeFactoryGUI();
         $like_gui = $likef->widget($obj_ids);
 
         $js_items = [];
         foreach ($this->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:

◆ readNewsData()

ilNewsTimelineGUI::readNewsData ( $excluded = [] )

protected

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

References $include_auto_entries, $period, and ILIAS\Repository\ctrl().

Referenced by getHTML(), and loadMore().

                                                    : void
     {
         $this->news_data = $this->manager->getNewsData(
             $this->ref_id,
             $this->ctrl->getContextObjId(),
             $this->ctrl->getContextObjType(),
             $this->period,
             $this->include_auto_entries,
             self::$items_per_load,
             $excluded
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove()

ilNewsTimelineGUI::remove ( )

Definition at line 437 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:

◆ renderDeleteModal()

ilNewsTimelineGUI::renderDeleteModal ( ilTemplate $tpl )

protected

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

References $c, ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by getHTML().

                                                          : void
     {
         $mbox = $this->gui->ui()->factory()->messageBox()->confirmation(
             $this->lng->txt("news_really_delete_news")
         );
         $title = $this->gui->ui()->factory()->legacy("<p id='news_delete_news_title'></p>");
         $modal = $this->gui->modal($this->lng->txt("delete"))
             ->content([$title, $mbox])
             ->button($this->lng->txt("delete"), "#", false, "il.News.remove(); return false;");
         $c = $modal->getTriggerButtonComponents("");
         $tpl->setVariable("DELETE_MODAL", $this->gui->ui()->renderer()->render($c["modal"]));
         $tpl->setVariable("SIGNAL_ID", $c["signal"]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderEditModal()

ilNewsTimelineGUI::renderEditModal	(	?ilPropertyFormGUI	$form,
		ilTemplate	$tpl
	)

protected

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

References getEditModal(), HTML_Template_IT\setVariable(), and ILIAS\Repository\ui().

Referenced by getHTML().

                                                                                   : void
     {
         $edit_modal = $this->getEditModal($form);
         $signal = $edit_modal->getShowSignal()->getId();
         $close_signal = $edit_modal->getCloseSignal()->getId();
         $tpl->setVariable("SHOW_EDIT_SIGNAL", $signal);
         $tpl->setVariable("CLOSE_EDIT_SIGNAL", $close_signal);
         $tpl->setVariable("EDIT_MODAL", $this->ui->renderer()->render($edit_modal));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilNewsTimelineGUI::save ( )

Definition at line 345 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 324 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:

◆ setEnableAddNews()

ilNewsTimelineGUI::setEnableAddNews ( bool $a_val )

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

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

◆ setPeriod()

ilNewsTimelineGUI::setPeriod ( int $a_val )

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

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

◆ setUserEditAll()

ilNewsTimelineGUI::setUserEditAll ( bool $a_val )

Set user can edit other users postings.

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

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

◆ show()

ilNewsTimelineGUI::show ( ilPropertyFormGUI $form = null )

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

References getHTML().

Referenced by save(), and update().

                                                         : void
     {
         $this->tpl->setContent($this->getHTML($form));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilNewsTimelineGUI::update ( )

Definition at line 387 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 333 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();
         }
     }