ilNewsTimelineItemGUI Class Reference

Single news timeline item. More...

Inheritance diagram for ilNewsTimelineItemGUI:

Collaboration diagram for ilNewsTimelineItemGUI:

Public Member Functions
	setNewsItem (ilNewsItem $a_val)
	getNewsItem ()
	setUserEditAll (bool $a_val)
	Set user can edit other users postings. More...
	getUserEditAll ()
	Get user can edit other users postings. More...
	getDateTime ()
	Get datetime. More...
	render ()
	Render item. More...
	renderFooter ()

Static Public Member Functions
static	getInstance (ilNewsItem $a_news_item, int $a_news_ref_id, ilLikeGUI $a_like_gui)

Protected Member Functions
	__construct (ilNewsItem $a_news_item, int $a_news_ref_id, ilLikeGUI $a_like_gui)
	renderMedia (ilNewsItem $i)
	renderMediaModal (ilNewsItem $i)
	getMediaPath (ilNewsItem $i)

Protected Attributes
ilLanguage	$lng
ilNewsItem	$news_item
ilObjectDefinition	$obj_def
ilObjUser	$user
bool	$user_edit_all
int	$news_item_ref_id
int	$ref_id
ilCtrl	$ctrl
ilLikeGUI	$like_gui
StandardGUIRequest	$std_request

Detailed Description

Single news timeline item.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilNewsTimelineItemGUI::__construct ( ilNewsItem  $a_news_item, int  $a_news_ref_id, ilLikeGUI  $a_like_gui  )

protected

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

References $DIC, ILIAS\Repository\ctrl(), ILIAS\News\StandardGUIRequest\getRefId(), ILIAS\Repository\lng(), setNewsItem(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->like_gui = $a_like_gui;
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->setNewsItem($a_news_item);
        $this->user = $DIC->user();
        $this->obj_def = $DIC["objDefinition"];
        $this->news_item_ref_id = $a_news_ref_id;

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

Here is the call graph for this function:

Member Function Documentation

getDateTime()

ilNewsTimelineItemGUI::getDateTime

(

)

Get datetime.

Returns

ilDateTime timestamp

Implements ilTimelineItemInt.

Definition at line 94 of file class.ilNewsTimelineItemGUI.php.

References $i, getNewsItem(), and IL_CAL_DATETIME.

Referenced by render().

                                 : ilDateTime
    {
        $i = $this->getNewsItem();
        return new ilDateTime($i->getCreationDate(), IL_CAL_DATETIME);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilNewsTimelineItemGUI::getInstance ( ilNewsItem  $a_news_item, int  $a_news_ref_id, ilLikeGUI  $a_like_gui  )

static

Definition at line 60 of file class.ilNewsTimelineItemGUI.php.

Referenced by ilNewsTimelineGUI\loadMore(), and ilNewsTimelineGUI\show().

     : self {
        return new self($a_news_item, $a_news_ref_id, $a_like_gui);
    }

Here is the caller graph for this function:

getMediaPath()

ilNewsTimelineItemGUI::getMediaPath ( ilNewsItem  $i )

protected

Definition at line 299 of file class.ilNewsTimelineItemGUI.php.

References ilObjMediaObject\_getURL(), ilObjMediaObject\getMediaItem(), and ilNewsItem\getMobId().

Referenced by renderMedia(), and renderMediaModal().

                                                  : string
    {
        $media_path = "";
        if ($i->getMobId() > 0) {
            $mob = new ilObjMediaObject($i->getMobId());
            $med = $mob->getMediaItem("Standard");
            if (strcasecmp("Reference", $med->getLocationType()) === 0) {
                $media_path = $med->getLocation();
            } else {
                $media_path = ilObjMediaObject::_getURL($mob->getId()) . "/" . $med->getLocation();
            }
        }
        return $media_path;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNewsItem()

ilNewsTimelineItemGUI::getNewsItem

(

)

Definition at line 73 of file class.ilNewsTimelineItemGUI.php.

References $news_item.

Referenced by getDateTime(), render(), and renderFooter().

                                 : ilNewsItem
    {
        return $this->news_item;
    }

Here is the caller graph for this function:

getUserEditAll()

ilNewsTimelineItemGUI::getUserEditAll

(

)

Get user can edit other users postings.

Definition at line 89 of file class.ilNewsTimelineItemGUI.php.

References $user_edit_all.

Referenced by render().

                                    : bool
    {
        return $this->user_edit_all;
    }

Here is the caller graph for this function:

render()

ilNewsTimelineItemGUI::render

(

)

Render item.

Returns

string html

Implements ilTimelineItemInt.

Definition at line 100 of file class.ilNewsTimelineItemGUI.php.

References $i, $tpl, ilObject\_exists(), ilObject\_getIcon(), ilObjUser\_getPersonalPicturePath(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ilNewsItem\determineNewsTitle(), ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, ilDatePresentation\formatDate(), getDateTime(), ilUserUtil\getNamePresentation(), getNewsItem(), ilNewsRendererFactory\getRenderer(), getUserEditAll(), IL_CAL_DATETIME, ILIAS\Repository\lng(), renderMedia(), and ILIAS\Repository\user().

                            : string
    {
        $i = $this->getNewsItem();
        $tpl = new ilTemplate("tpl.timeline_item.html", true, true, "Services/News");

        $news_renderer = ilNewsRendererFactory::getRenderer($i->getContextObjType());
        $news_renderer->setLanguage($this->lng->getLangKey());
        $news_renderer->setNewsItem($i, $this->news_item_ref_id);

        $obj_id = $i->getContextObjId();

        // edited?
        if ($i->getCreationDate() !== $i->getUpdateDate()) {
            $tpl->setCurrentBlock("edited");
            $update_date = new ilDateTime($i->getUpdateDate(), IL_CAL_DATETIME);
            $tpl->setVariable("TXT_EDITED", $this->lng->txt("cont_news_edited"));
            if ($i->getUpdateUserId() > 0 && ($i->getUpdateUserId() !== $i->getUserId())) {
                $tpl->setVariable("TXT_USR_EDITED", ilUserUtil::getNamePresentation(
                    $i->getUpdateUserId(),
                    false,
                    true,
                    $this->ctrl->getLinkTargetByClass("ilnewstimelinegui")
                ) . " - ");
            }
            $tpl->setVariable("TIME_EDITED", ilDatePresentation::formatDate($update_date));
            $tpl->parseCurrentBlock();
        }

        // context object link
        if ($this->news_item_ref_id > 0 && $this->ref_id !== $this->news_item_ref_id) {
            $tpl->setCurrentBlock("object");
            $tpl->setVariable("OBJ_TITLE", ilObject::_lookupTitle($obj_id));
            $tpl->setVariable("OBJ_IMG", ilObject::_getIcon($obj_id));
            $tpl->setVariable("OBJ_HREF", $news_renderer->getObjectLink());
            $tpl->parseCurrentBlock();
        }

        // media
        if ($i->getMobId() > 0 && ilObject::_exists($i->getMobId())) {
            $media = $this->renderMedia($i);
            $tpl->setCurrentBlock("player");
            $tpl->setVariable("PLAYER", $media);
            $tpl->parseCurrentBlock();
        }

        $tpl->setVariable("USER_IMAGE", ilObjUser::_getPersonalPicturePath($i->getUserId(), "small"));
        $tpl->setVariable(
            "TITLE",
            ilNewsItem::determineNewsTitle($i->getContextObjType(), $i->getTitle(), $i->getContentIsLangVar())
        );

        // content
        $tpl->setVariable("CONTENT", $news_renderer->getTimelineContent());

        $tpl->setVariable("TXT_USR", ilUserUtil::getNamePresentation(
            $i->getUserId(),
            false,
            true,
            $this->ctrl->getLinkTargetByClass("ilnewstimelinegui")
        ));

        $tpl->setVariable("TIME", ilDatePresentation::formatDate($this->getDateTime()));

        // actions
        $list = new ilAdvancedSelectionListGUI();
        $list->setListTitle("");
        $list->setId("news_tl_act_" . $i->getId());
        $list->setHeaderIcon(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK);
        $list->setUseImages(false);

        if ($i->getPriority() === 1 && ($i->getUserId() === $this->user->getId() || $this->getUserEditAll())) {
            if (!$news_renderer->preventEditing()) {
                $list->addItem(
                    $this->lng->txt("edit"),
                    "",
                    "",
                    "",
                    "",
                    "",
                    "",
                    false,
                    "il.News.edit(" . $i->getId() . ");"
                );
                $list->addItem(
                    $this->lng->txt("delete"),
                    "",
                    "",
                    "",
                    "",
                    "",
                    "",
                    false,
                    "il.News.delete(" . $i->getId() . ");"
                );
            }
        }

        $news_renderer->addTimelineActions($list);

        $tpl->setVariable("ACTIONS", $list->getHTML());

        return $tpl->get();
    }

Here is the call graph for this function:

renderFooter()

ilNewsTimelineItemGUI::renderFooter

(

)

Definition at line 263 of file class.ilNewsTimelineItemGUI.php.

References $i, ILIAS\Repository\ctrl(), getNewsItem(), renderMediaModal(), and ilNoteGUI\setDefaultCommand().

                                  : string
    {
        $i = $this->getNewsItem();

        // like
        $this->ctrl->setParameterByClass("ilnewstimelinegui", "news_id", $i->getId());
        $this->like_gui->setObject(
            $i->getContextObjId(),
            $i->getContextObjType(),
            $i->getContextSubObjId(),
            (string) $i->getContextSubObjType(),
            $i->getId()
        );
        $html = $this->ctrl->getHTML($this->like_gui);

        // comments
        $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->setDefaultCommand("getWidget");
        $note_gui->setShowEmptyListMessage(false);
        $note_gui->setShowHeader(false);
        $html .= $this->ctrl->getHTML($note_gui);

        $this->ctrl->setParameterByClass("ilnewstimelinegui", "news_id", $this->std_request->getNewsId());

        return $html . $this->renderMediaModal($i);
    }

Here is the call graph for this function:

renderMedia()

ilNewsTimelineItemGUI::renderMedia ( ilNewsItem  $i )

protected

Definition at line 204 of file class.ilNewsTimelineItemGUI.php.

References $DIC, ilNewsItem\getId(), getMediaPath(), and ilObjMediaObject\getMimeType().

Referenced by render().

                                                 : string
    {
        global $DIC;

        $media_path = $this->getMediaPath($i);
        $mime = ilObjMediaObject::getMimeType($media_path);

        $ui_factory = $DIC->ui()->factory();
        $ui_renderer = $DIC->ui()->renderer();

        if (in_array($mime, ["image/jpeg", "image/svg+xml", "image/gif", "image/png"])) {
            $item_id = "il-news-modal-img-" . $i->getId();
            $title = basename($media_path);
            $image = $ui_renderer->render($ui_factory->image()->responsive($media_path, $title));

            $img_tpl = new ilTemplate("tpl.news_timeline_image_file.html", true, true, "Services/News");
            $img_tpl->setVariable("ITEM_ID", $item_id);
            $img_tpl->setVariable("IMAGE", $image);

            $html = $img_tpl->get();
        } elseif (in_array($mime, ["video/mp4"])) {
            $video = $ui_factory->player()->video($media_path);
            $html = $ui_renderer->render($video);
        } elseif (in_array($mime, ["audio/mpeg"])) {
            $audio = $ui_factory->player()->audio($media_path);
            $html = $ui_renderer->render($audio);
        } else {
            // download?
            $html = "";
        }
        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderMediaModal()

ilNewsTimelineItemGUI::renderMediaModal ( ilNewsItem  $i )

protected

Definition at line 237 of file class.ilNewsTimelineItemGUI.php.

References $DIC, ilNewsItem\getId(), ilModalGUI\getInstance(), getMediaPath(), ilObjMediaObject\getMimeType(), and ilModalGUI\TYPE_LARGE.

Referenced by renderFooter().

                                                      : string
    {
        global $DIC;

        $media_path = $this->getMediaPath($i);
        $mime = ilObjMediaObject::getMimeType($media_path);

        $ui_factory = $DIC->ui()->factory();
        $ui_renderer = $DIC->ui()->renderer();

        $modal_html = "";

        if (in_array($mime, ["image/jpeg", "image/svg+xml", "image/gif", "image/png"])) {
            $title = basename($media_path);
            $item_id = "il-news-modal-img-" . $i->getId();
            $image = $ui_renderer->render($ui_factory->image()->responsive($media_path, $title));
            $modal = ilModalGUI::getInstance();
            $modal->setId($item_id);
            $modal->setType(ilModalGUI::TYPE_LARGE);
            $modal->setBody($image);
            $modal->setHeading($title);
            $modal_html = $modal->getHTML();
        }
        return $modal_html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setNewsItem()

ilNewsTimelineItemGUI::setNewsItem

(

ilNewsItem

$a_val

)

Definition at line 68 of file class.ilNewsTimelineItemGUI.php.

Referenced by __construct().

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

Here is the caller graph for this function:

setUserEditAll()

ilNewsTimelineItemGUI::setUserEditAll

(

bool

$a_val

)

Set user can edit other users postings.

Definition at line 81 of file class.ilNewsTimelineItemGUI.php.

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

Field Documentation

$ctrl

ilCtrl ilNewsTimelineItemGUI::$ctrl

protected

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

$like_gui

ilLikeGUI ilNewsTimelineItemGUI::$like_gui

protected

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

$lng

ilLanguage ilNewsTimelineItemGUI::$lng

protected

Definition at line 27 of file class.ilNewsTimelineItemGUI.php.

$news_item

ilNewsItem ilNewsTimelineItemGUI::$news_item

protected

Definition at line 28 of file class.ilNewsTimelineItemGUI.php.

Referenced by getNewsItem().

$news_item_ref_id

int ilNewsTimelineItemGUI::$news_item_ref_id

protected

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

$obj_def

ilObjectDefinition ilNewsTimelineItemGUI::$obj_def

protected

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

$ref_id

int ilNewsTimelineItemGUI::$ref_id

protected

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

$std_request

StandardGUIRequest ilNewsTimelineItemGUI::$std_request

protected

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

$user

ilObjUser ilNewsTimelineItemGUI::$user

protected

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

$user_edit_all

bool ilNewsTimelineItemGUI::$user_edit_all

protected

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

Referenced by getUserEditAll().

---

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

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