ilNewsTimelineGUI Class Reference

Timeline for news. More...

Collaboration diagram for ilNewsTimelineGUI:

Public Member Functions
	setUserEditAll ($a_val)
	Set user can edit other users postings. More...
	getUserEditAll ()
	Get user can edit other users postings. More...
	executeCommand ()
	Execute command. More...
	show ($form=null)
	Show. More...
	loadMore ()
	Load more. More...
	save ()
	Save (ajax) More...
	update ()
	Update (ajax) More...
	remove ()
	Remove (ajax) More...

Static Public Member Functions
static	getInstance ($a_ref_id, $a_include_auto_entries)
	Get instance. More...

Protected Member Functions
	__construct ($a_ref_id, $a_include_auto_entries)
	Constructor. More...
	updateNewsItem ()
	getEditModal ($form=null)
	Get edit modal. More...
	getDeleteModal ()
	Get delete modal. More...

Protected Attributes
	$ctrl
	$tpl
	$ref_id
	$lng
	$toolbar
	$user
	$access
	$user_edit_all = false

Static Protected Attributes
static	$items_per_load = 10

Detailed Description

Timeline for news.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

@ilCtrl_Calls ilNewsTimelineGUI: ilLikeGUI, ilNoteGUI

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

Constructor & Destructor Documentation

__construct()

ilNewsTimelineGUI::__construct (   $a_ref_id,   $a_include_auto_entries  )

protected

Constructor.

Parameters

int

$a_ref_id

reference id

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

    {
        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->news_id = (int) $_GET["news_id"];
 
 
        $this->lng->loadLanguageModule("news");
    }

References $_GET, $DIC, and user().

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilNewsTimelineGUI::executeCommand

(

)

Execute command.

Exceptions

ilCtrlException

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

    {
        $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);
                include_once("./Services/Like/classes/class.ilLikeFactoryGUI.php");
                $likef = new ilLikeFactoryGUI();
                $like_gui = $likef->widget(array($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()
                );
                $ret = $ctrl->forwardCommand($note_gui);
                break;
 
            default:
                if (in_array($cmd, array("show", "save", "update", "loadMore", "remove", "updateNewsItem"))) {
                    $this->$cmd();
                }
        }
    }

References $ctrl, $i, and $ret.

getDeleteModal()

ilNewsTimelineGUI::getDeleteModal ( )

protected

Get delete modal.

Returns

string modal html

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

    {
        include_once("./Services/UIComponent/Modal/classes/class.ilModalGUI.php");
        $modal = ilModalGUI::getInstance();
        $modal->setHeading($this->lng->txt("delete"));
        $modal->setId("ilNewsDeleteModal");
        $modal->setType(ilModalGUI::TYPE_LARGE);
 
        require_once 'Services/UIComponent/Button/classes/class.ilSubmitButton.php';
        $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();
    }

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

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

getEditModal()

ilNewsTimelineGUI::getEditModal (   $form = null )

protected

Get edit modal.

Returns

string modal html

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

    {
        include_once("./Services/UIComponent/Modal/classes/class.ilModalGUI.php");
        $modal = ilModalGUI::getInstance();
        $modal->setHeading($this->lng->txt("edit"));
        $modal->setId("ilNewsEditModal");
        $modal->setType(ilModalGUI::TYPE_LARGE);
 
        include_once("./Services/News/classes/class.ilNewsItemGUI.php");
        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();
    }

References ilNewsItemGUI\FORM_EDIT, ilNewsItemGUI\getEditForm(), ilModalGUI\getInstance(), and ilModalGUI\TYPE_LARGE.

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

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

static

Get instance.

Parameters

int

$a_ref_id

reference id

Returns

ilNewsTimelineGUI

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

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

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

Here is the caller graph for this function:

getUserEditAll()

ilNewsTimelineGUI::getUserEditAll

(

)

Get user can edit other users postings.

Returns

bool user can edit all postings

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

    {
        return $this->user_edit_all;
    }

References $user_edit_all.

Referenced by loadMore(), and show().

Here is the caller graph for this function:

loadMore()

ilNewsTimelineGUI::loadMore

(

)

Load more.

Parameters

return

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

    {
        include_once("./Services/News/classes/class.ilNewsItem.php");
        $news_item = new ilNewsItem();
        $news_item->setContextObjId($this->ctrl->getContextObjId());
        $news_item->setContextObjType($this->ctrl->getContextObjType());
 
        $excluded = $_POST["rendered_news"];
 
        $news_data = $news_item->getNewsForRefId(
            $this->ref_id,
            false,
            false,
            0,
            true,
            false,
            !$this->include_auto_entries,
            false,
            null,
            self::$items_per_load,
            $excluded
        );
 
        include_once("./Services/News/Timeline/classes/class.ilTimelineGUI.php");
        include_once("./Services/News/classes/class.ilNewsTimelineItemGUI.php");
        $timeline = ilTimelineGUI::getInstance();
 
        // get like widget
        $obj_ids = array_unique(array_map(function ($a) {
            return $a["context_obj_id"];
        }, $news_data));
        include_once("./Services/Like/classes/class.ilLikeFactoryGUI.php");
        $likef = new ilLikeFactoryGUI();
        $like_gui = $likef->widget($obj_ids);
 
        $js_items = array();
        foreach ($news_data as $d) {
            $news_item = new ilNewsItem($d["id"]);
            $item = ilNewsTimelineItemGUI::getInstance($news_item, $d["ref_id"], $like_gui);
            $item->setUserEditAll($this->getUserEditAll());
            $timeline->addItem($item);
            $js_items[$d["id"]] = array(
                "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"]
            );
        }
 
        include_once("./Services/JSON/classes/class.ilJsonUtil.php");
        $obj = new stdClass();
        $obj->data = $js_items;
        $obj->html = $timeline->render(true);
 
        echo ilJsonUtil::encode($obj);
        exit;
    }

References $_POST, Vendor\Package\$a, $d, ilJsonUtil\encode(), exit, ilTimelineGUI\getInstance(), ilNewsTimelineItemGUI\getInstance(), and getUserEditAll().

Here is the call graph for this function:

remove()

ilNewsTimelineGUI::remove

(

)

Remove (ajax)

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

    {
        include_once("./Services/News/classes/class.ilNewsItemGUI.php");
        $news_item = new ilNewsItem((int) $_POST["id"]);
        if ($this->user->getId() == $news_item->getUserId() || $this->getUserEditAll()) {
            $news_item->delete();
        }
        exit;
    }

References $_POST, exit, and user().

Here is the call graph for this function:

save()

ilNewsTimelineGUI::save

(

)

Save (ajax)

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

    {
        include_once("./Services/News/classes/class.ilNewsItemGUI.php");
        $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"));
            include_once("./Services/News/classes/class.ilNewsItemGUI.php");
            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);");
        }
    }

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

Referenced by updateNewsItem().

Here is the call graph for this function:

Here is the caller graph for this function:

setUserEditAll()

ilNewsTimelineGUI::setUserEditAll

(

$a_val

)

Set user can edit other users postings.

Parameters

bool

$a_val

user can edit all postings

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

    {
        $this->user_edit_all = $a_val;
    }

show()

ilNewsTimelineGUI::show

(

$form = null

)

Show.

Parameters

return

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

    {
        // 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);
        }
 
        include_once("./Services/News/classes/class.ilNewsItem.php");
        $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
        );
 
        include_once("./Services/News/Timeline/classes/class.ilTimelineGUI.php");
        include_once("./Services/News/classes/class.ilNewsTimelineItemGUI.php");
        $timeline = ilTimelineGUI::getInstance();
 
        // get like widget
        $obj_ids = array_unique(array_map(function ($a) {
            return $a["context_obj_id"];
        }, $news_data));
        include_once("./Services/Like/classes/class.ilLikeFactoryGUI.php");
        $likef = new ilLikeFactoryGUI();
        $like_gui = $likef->widget($obj_ids);
 
        $js_items = array();
        foreach ($news_data as $d) {
            $news_item = new ilNewsItem($d["id"]);
            $item = ilNewsTimelineItemGUI::getInstance($news_item, $d["ref_id"], $like_gui);
            $item->setUserEditAll($this->getUserEditAll());
            $timeline->addItem($item);
            $js_items[$d["id"]] = array(
                "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"]
            );
        }
 
        include_once("./Services/JSON/classes/class.ilJsonUtil.php");
        $this->tpl->addOnloadCode("il.News.setItems(" . ilJsonUtil::encode($js_items) . ");");
        $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 {
            ilUtil::sendInfo($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");
        include_once("./Services/MediaObjects/classes/class.ilMediaPlayerGUI.php");
        ilMediaPlayerGUI::initJavascript($this->tpl);
    }

References Vendor\Package\$a, Vendor\Package\$b, $d, ilJsonUtil\encode(), getDeleteModal(), getEditModal(), ilUtil\getImagePath(), ilTimelineGUI\getInstance(), ilLinkButton\getInstance(), ilNewsTimelineItemGUI\getInstance(), getUserEditAll(), ilMediaPlayerGUI\initJavascript(), and ilUtil\sendInfo().

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilNewsTimelineGUI::update

(

)

Update (ajax)

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

    {
        include_once("./Services/News/classes/class.ilNewsItemGUI.php");
        $form = ilNewsItemGUI::getEditForm(ilNewsItemGUI::FORM_EDIT, $this->ref_id);
        if ($form->checkInput()) {
            $news_item = new ilNewsItem((int) $_POST["id"]);
            $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"));
            include_once("./Services/News/classes/class.ilNewsItemGUI.php");
            if (ilNewsItemGUI::isRteActivated()) {
                $news_item->setContentHtml(true);
            }
            $news_item->setContentLong("");
 
            $media = $_FILES["media"];
            $old_mob_id = 0;
 
            // delete old media object
            if ($media["name"] != "" || $_POST["media_delete"] != "") {
                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) {
                    include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                    $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(" . (int) $_POST["id"] . ", true);");
        }
    }

References $_POST, ilObject\_lookupObjectId(), ilObject\_lookupType(), ilObjMediaObject\_saveTempFileAsMediaObject(), ilNewsItemGUI\FORM_EDIT, ilNewsItemGUI\getEditForm(), ilNewsItemGUI\isRteActivated(), show(), and user().

Referenced by updateNewsItem().

Here is the call graph for this function:

Here is the caller graph for this function:

updateNewsItem()

ilNewsTimelineGUI::updateNewsItem ( )

protected

Parameters

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

    {
        if ($_POST["news_action"] == "save") {
            $this->save();
        }
        if ($_POST["news_action"] == "update") {
            $this->update();
        }
    }

References $_POST, save(), and update().

Here is the call graph for this function:

Field Documentation

$access

ilNewsTimelineGUI::$access

protected

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

$ctrl

ilNewsTimelineGUI::$ctrl

protected

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

Referenced by executeCommand().

$items_per_load

ilNewsTimelineGUI::$items_per_load = 10

staticprotected

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

$lng

ilNewsTimelineGUI::$lng

protected

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

$ref_id

ilNewsTimelineGUI::$ref_id

protected

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

$toolbar

ilNewsTimelineGUI::$toolbar

protected

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

$tpl

ilNewsTimelineGUI::$tpl

protected

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

$user

ilNewsTimelineGUI::$user

protected

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

$user_edit_all

ilNewsTimelineGUI::$user_edit_all = false

protected

Definition at line 60 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