Single news timeline item. More...

Inheritance diagram for ilNewsTimelineItemGUI:

Collaboration diagram for ilNewsTimelineItemGUI:

Public Member Functions
	setNewsItem (ilNewsItem $a_val)
	Set news item. More...

	getNewsItem ()
	Get news item. More...

	setUserEditAll ($a_val)
	Set user can edit other users postings. More...

	getUserEditAll ()
	Get user can edit other users postings. More...

	getDateTime ()
	Get datetime. Returns ilDateTime timestamp More...

	render ()
	Render item. Returns string html More...

	renderFooter ()
	Render footer. More...

Static Public Member Functions
static	getInstance (ilNewsItem $a_news_item, $a_news_ref_id, \ilLikeGUI $a_like_gui)
	Get instance. More...

Protected Member Functions
	__construct (ilNewsItem $a_news_item, $a_news_ref_id, \ilLikeGUI $a_like_gui)
	Constructor. More...

	renderMedia (ilNewsItem $i)
	Render media. More...

	renderMediaModal (ilNewsItem $i)
	Render media. More...

	getMediaPath (ilNewsItem $i)

Protected Attributes
	$lng

	$news_item

	$obj_def

	$user

	$user_edit_all

	$news_item_ref_id

	$ref_id

	$ctrl

	$like_gui

Detailed Description

Single news timeline item.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

protected

Constructor.

Parameters

ilNewsItem	$a_news_item
	$a_news_ref_id
ilLikeGUI	$a_like_gui

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

References $_GET, $DIC, setNewsItem(), and 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->ref_id = (int) $_GET["ref_id"];
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDateTime()

ilNewsTimelineItemGUI::getDateTime ( )

Get datetime.

Returns: ilDateTime timestamp

Implements ilTimelineItemInt.

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

References $i, getNewsItem(), and IL_CAL_DATETIME.

Referenced by render().

     {
         $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,
			$a_news_ref_id,
		\ilLikeGUI	$a_like_gui
	)

static

Get instance.

Parameters

ilNewsItem $a_news_item news item

Returns: ilNewsTimelineItemGUI

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

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

     {
         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

Parameters

ilNewsItem $i

Returns: string

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

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

Referenced by renderMedia(), and renderMediaModal().

     {
         $media_path = "";
         if ($i->getMobId() > 0) {
             include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
             include_once("./Services/MediaObjects/classes/class.ilMediaPlayerGUI.php");
             $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 ( )

Get news item.

Returns: ilNewsItem news item

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

References $news_item.

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

     {
         return $this->news_item;
     }

Here is the caller graph for this function:

◆ getUserEditAll()

ilNewsTimelineItemGUI::getUserEditAll ( )

Get user can edit other users postings.

Returns: bool user can edit all postings

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

References $user_edit_all.

Referenced by render().

     {
         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 140 of file class.ilNewsTimelineItemGUI.php.

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

     {
         $i = $this->getNewsItem();
         $tpl = new ilTemplate("tpl.timeline_item.html", true, true, "Services/News");
 
         include_once("./Services/News/classes/class.ilNewsRendererFactory.php");
         $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())) {
                 include_once("./Services/User/classes/class.ilUserUtil.php");
                 $tpl->setVariable("TXT_USR_EDITED", ilUserUtil::getNamePresentation(
                     $i->getUpdateUserId(),
                     false,
                     true,
                     $this->ctrl->getLinkTargetByClass("ilnewstimelinegui")
                 ) . " - ");
             }
             include_once("./Services/Calendar/classes/class.ilDatePresentation.php");
             $tpl->setVariable("TIME_EDITED", ilDatePresentation::formatDate($update_date));
             $tpl->parseCurrentBlock();
         }
 
         // context object link
         include_once("./Services/Link/classes/class.ilLink.php");
         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());
 
         include_once("./Services/User/classes/class.ilUserUtil.php");
         $tpl->setVariable("TXT_USR", ilUserUtil::getNamePresentation(
             $i->getUserId(),
             false,
             true,
             $this->ctrl->getLinkTargetByClass("ilnewstimelinegui")
         ));
 
         include_once("./Services/Calendar/classes/class.ilDatePresentation.php");
         $tpl->setVariable("TIME", ilDatePresentation::formatDate($this->getDateTime()));
 
         // actions
         include_once("Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
         $list = new ilAdvancedSelectionListGUI();
         $list->setListTitle("");
         $list->setId("news_tl_act_" . $i->getId());
         //$list->setSelectionHeaderClass("small");
         //$list->setItemLinkClass("xsmall");
         //$list->setLinksMode("il_ContainerItemCommand2");
         $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 ( )

Render footer.

Exceptions

ilCtrlException

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

References $_GET, $i, getNewsItem(), renderMediaModal(), and ilNoteGUI\setDefaultCommand().

     {
         $i = $this->getNewsItem();
 
         // like
         $this->ctrl->setParameterByClass("ilnewstimelinegui", "news_id", $i->getId());
         $this->like_gui->setObject(
             $i->getContextObjId(),
             $i->getContextObjType(),
             $i->getContextSubObjId(),
             $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");
 
         //ilNoteGUI::getListCommentsJSCall($this->ajax_hash, $redraw_js)
         $html .= $this->ctrl->getHTML($note_gui);
 
         $this->ctrl->setParameterByClass("ilnewstimelinegui", "news_id", $_GET["news_id"]);
 
         return $html . $this->renderMediaModal($i);
     }

Here is the call graph for this function:

◆ renderMedia()

ilNewsTimelineItemGUI::renderMedia ( ilNewsItem $i )

protected

Render media.

Parameters

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

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

Referenced by render().

     {
         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, array("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, array("audio/mpeg", "audio/ogg", "video/mp4", "video/x-flv", "video/webm"))) {
             $mp = new ilMediaPlayerGUI();
             $mp->setFile($media_path);
             $html = $mp->getMediaPlayerHtml();
         } 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

Render media.

Parameters

ilNewsItem

Returns: string

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

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

Referenced by renderFooter().

     {
         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, array("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 )

Set news item.

Parameters

ilNewsItem $a_val news item

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

Referenced by __construct().

     {
         $this->news_item = $a_val;
     }

Here is the caller graph for this function:

◆ setUserEditAll()

ilNewsTimelineItemGUI::setUserEditAll ( $a_val )

Set user can edit other users postings.

Parameters

bool $a_val user can edit all postings

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

     {
         $this->user_edit_all = $a_val;
     }

Field Documentation

◆ $ctrl

ilNewsTimelineItemGUI::$ctrl

protected

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

◆ $like_gui

ilNewsTimelineItemGUI::$like_gui

protected

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

◆ $lng

ilNewsTimelineItemGUI::$lng

protected

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

◆ $news_item

ilNewsTimelineItemGUI::$news_item

protected

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

Referenced by getNewsItem().

◆ $news_item_ref_id

ilNewsTimelineItemGUI::$news_item_ref_id

protected

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

◆ $obj_def

ilNewsTimelineItemGUI::$obj_def

protected

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

◆ $ref_id

ilNewsTimelineItemGUI::$ref_id

protected

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

◆ $user

ilNewsTimelineItemGUI::$user

protected

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

◆ $user_edit_all

ilNewsTimelineItemGUI::$user_edit_all

protected

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDateTime()

◆ getInstance()

◆ getMediaPath()

◆ getNewsItem()

◆ getUserEditAll()

◆ render()

◆ renderFooter()

◆ renderMedia()

◆ renderMediaModal()

◆ setNewsItem()

◆ setUserEditAll()

Field Documentation

◆ $ctrl

◆ $like_gui

◆ $lng

◆ $news_item

◆ $news_item_ref_id

◆ $obj_def

◆ $ref_id

◆ $user

◆ $user_edit_all