ilNewsTimelineItemGUI Class Reference

Single news timeline item. More...

Inheritance diagram for ilNewsTimelineItemGUI:

Collaboration diagram for ilNewsTimelineItemGUI:

Public Member Functions
	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 ()
	render ()
	Render item. More...
	getDateTime ()
	Get datetime. More...

Static Public Member Functions
static	getInstance (NewsItem $news_item, ilLikeGUI $like_gui)

Protected Member Functions
	__construct (protected readonly NewsItem $news_item, protected readonly ilLikeGUI $like_gui)
	renderMedia ()
	renderMediaModal ()
	getMediaPath ()

Protected Attributes
ILIAS News InternalGUIService	$gui
ILIAS Notes Service	$notes
ilLanguage	$lng
ilObjectDefinition	$obj_def
ilObjUser	$user
bool	$user_edit_all
int	$ref_id
ilCtrl	$ctrl
StandardGUIRequest	$std_request
array	$item_image = []
array	$item_modal = []
readonly ilObjMediaObject	$media_object

Detailed Description

Single news timeline item.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilNewsTimelineItemGUI::__construct ( protected readonly NewsItem  $news_item, protected readonly ilLikeGUI  $like_gui  )

protected

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

      {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->obj_def = $DIC["objDefinition"];
 
        $this->std_request = $DIC->news()
            ->internal()
            ->gui()
            ->standardRequest();
        $this->ref_id = $this->std_request->getRefId();
        $this->gui = $DIC->news()
            ->internal()
            ->gui();
        $this->notes = $DIC->notes();
        $this->media_object = new ilObjMediaObject($this->news_item->getMobId());
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

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.

                                 : ilDateTime
    {
        return new ilDateTime($this->news_item->getCreationDate()->format('c'), IL_CAL_DATETIME);
    }

References IL_CAL_DATETIME.

getInstance()

static ilNewsTimelineItemGUI::getInstance ( NewsItem  $news_item, ilLikeGUI  $like_gui  )

static

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

     : self {
        return new self($news_item, $like_gui);
    }

getMediaPath()

ilNewsTimelineItemGUI::getMediaPath ( )

protected

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

                                     : string
    {
        return $this->news_item->getMobId() > 0 ? $this->media_object->getStandardSrc() : "";
    }

getUserEditAll()

ilNewsTimelineItemGUI::getUserEditAll

(

)

Get user can edit other users postings.

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

                                    : bool
    {
        return $this->user_edit_all;
    }

render()

ilNewsTimelineItemGUI::render

(

)

Render item.

Returns

string html

Implements ilTimelineItemInt.

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

                            : string
    {
        $tpl = new ilTemplate("tpl.timeline_item.html", true, true, "components/ILIAS/News");
        $ui_factory = $this->gui->ui()->factory();
        $ui_renderer = $this->gui->ui()->renderer();
 
        $news_renderer = ilNewsRendererFactory::getRenderer($this->news_item->getContextObjType());
        $news_renderer->setLanguage($this->lng->getLangKey());
        $news_renderer->setNewsItem($this->news_item->toLegacy(), $this->news_item->getContextRefId());
 
        $obj_id = $this->news_item->getContextObjId();
 
        // edited?
        if ($this->news_item->getCreationDate() !== $this->news_item->getUpdateDate()) {
            $tpl->setCurrentBlock("edited");
            $update_date = new ilDateTime($this->news_item->getUpdateDate()->format('c'), IL_CAL_DATETIME);
            $tpl->setVariable("TXT_EDITED", $this->lng->txt("cont_news_edited"));
            if (
                $this->news_item->getUpdateUserId() > 0 &&
                ($this->news_item->getUpdateUserId() !== $this->news_item->getUserId())
            ) {
                $tpl->setVariable("TXT_USR_EDITED", ilUserUtil::getNamePresentation(
                    $this->news_item->getUpdateUserId(),
                    false,
                    true,
                    $this->ctrl->getLinkTargetByClass(ilNewsTimelineGUI::class)
                ) . " - ");
            }
            $tpl->setVariable("TIME_EDITED", ilDatePresentation::formatDate($update_date));
            $tpl->parseCurrentBlock();
        }
 
        // context object link
        if ($this->news_item->getContextRefId() > 0 && $this->ref_id !== $this->news_item->getContextRefId()) {
            $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 ($this->news_item->getMobId() > 0 && ilObject::_exists($this->news_item->getMobId())) {
            $media = $this->renderMedia();
            $tpl->setCurrentBlock("player");
            $tpl->setVariable("PLAYER", $media);
            $tpl->parseCurrentBlock();
        }
 
        $p = $this->gui->profile();
        $tpl->setVariable("USER_AVATAR", $this->gui->ui()->renderer()->render(
            $p->getAvatar($this->news_item->getUserId())
        ));
        $tpl->setVariable(
            "TITLE",
            ilNewsItem::determineNewsTitle(
                $this->news_item->getContextObjType(),
                $this->news_item->getTitle(),
                $this->news_item->isContentIsLangVar()
            )
        );
 
        // content
        $tpl->setVariable("CONTENT", $news_renderer->getTimelineContent());
 
        $tpl->setVariable("TXT_USR", $p->getNamePresentation(
            $this->news_item->getUserId(),
            true,
            $this->ctrl->getLinkTargetByClass(ilNewsTimelineGUI::class)
        ));
 
        $tpl->setVariable("TIME", ilDatePresentation::formatDate($this->getDateTime()));
 
        // actions
        $actions = [];
 
        if (
            $this->news_item->getPriority() === 1 &&
            ($this->news_item->getUserId() === $this->user->getId() || $this->getUserEditAll())
        ) {
            if (!$news_renderer->preventEditing()) {
                $i = $this->news_item;
                $actions[] = $ui_factory->button()->shy(
                    $this->lng->txt("edit"),
                    ""
                )->withOnLoadCode(static function ($id) use ($i) {
                    return "document.getElementById('$id').addEventListener('click', () => {il.News.edit(" . $i->getId() . ");});";
                });
                $actions[] = $ui_factory->button()->shy(
                    $this->lng->txt("delete"),
                    ""
                )->withOnLoadCode(static function ($id) use ($i) {
                    return "document.getElementById('$id').addEventListener('click', () => {il.News.delete(" . $i->getId() . ");});";
                });
            }
        }
        foreach ($news_renderer->getTimelineActions() as $action) {
            $actions[] = $action;
        }
        $dd = $ui_factory->dropdown()->standard($actions);
        $tpl->setVariable("ACTIONS", $ui_renderer->render($dd));
 
        return $tpl->get();
    }

References $id, ilObject\_exists(), ilObject\_getIcon(), ilObject\_lookupTitle(), ilNewsItem\determineNewsTitle(), ilDatePresentation\formatDate(), ilUserUtil\getNamePresentation(), ilNewsRendererFactory\getRenderer(), IL_CAL_DATETIME, and ILIAS\Repository\lng().

Here is the call graph for this function:

renderFooter()

ilNewsTimelineItemGUI::renderFooter

(

)

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

                                  : string
    {
        // like
        $this->ctrl->setParameterByClass(ilNewsTimelineGUI::class, "news_id", $this->news_item->getId());
        $this->like_gui->setObject(
            $this->news_item->getContextObjId(),
            $this->news_item->getContextObjType(),
            $this->news_item->getContextSubObjId(),
            (string) $this->news_item->getContextSubObjType(),
            $this->news_item->getId()
        );
        $html = $this->ctrl->getHTML($this->like_gui);
 
        // comments
        $notes_obj_type = ($this->news_item->getContextSubObjType() === null)
            ? $this->news_item->getContextObjType()
            : $this->news_item->getContextSubObjType();
        $comments_gui = $this->notes->gui()->getCommentsGUI(
            $this->news_item->getContextObjId(),
            $this->news_item->getContextSubObjId(),
            $notes_obj_type,
            $this->news_item->getId()
        );
        $comments_gui->setDefaultCommand("getWidget");
        $comments_gui->setShowEmptyListMessage(false);
        $comments_gui->setShowHeader(false);
        $html .= $comments_gui->getWidget();
        //$html .= $this->ctrl->getHTML($comments_gui);
 
        $this->ctrl->setParameterByClass(ilNewsTimelineGUI::class, "news_id", $this->std_request->getNewsId());
 
        return $html . $this->renderMediaModal($this->news_item);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

renderMedia()

ilNewsTimelineItemGUI::renderMedia ( )

protected

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

                                    : string
    {
        $media_path = $this->getMediaPath();
        $mime = ilObjMediaObject::getMimeType($media_path);
 
        $ui_factory = $this->gui->ui()->factory();
        $ui_renderer = $this->gui->ui()->renderer();
 
        if (in_array($mime, ["image/jpeg", "image/svg+xml", "image/gif", "image/png"])) {
            if (isset($this->item_image[$this->news_item->getId()]) && isset($this->item_modal[$this->news_item->getId()])) {
                $image = $this->item_image[$this->news_item->getId()];
            } else {
                $title = $this->media_object->getTitle();
                $image = $ui_factory->image()->responsive($media_path, $title);
                $modal_page = $ui_factory->modal()->lightboxImagePage($image, $title);
                $modal = $ui_factory->modal()->lightbox($modal_page);
                $image = $image->withAction($modal->getShowSignal());
                $this->item_image[$this->news_item->getId()] = $image;
                $this->item_modal[$this->news_item->getId()] = $modal;
            }
            $html = $ui_renderer->render($image);
        } elseif (in_array($mime, ["video/mp4", "video/youtube", "video/vimeo"])) {
            $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);
        } elseif (in_array($mime, ["application/pdf"])) {
            $this->ctrl->setParameterByClass(ilNewsTimelineGUI::class, "news_id", $this->news_item->getId());
            $link = $ui_factory->link()->standard(
                basename($media_path),
                $this->ctrl->getLinkTargetByClass(ilNewsTimelineGUI::class, "downloadMob")
            );
            $html = $ui_renderer->render($link);
            $this->ctrl->setParameterByClass(ilNewsTimelineGUI::class, "news_id", null);
        } else {
            $html = "";
        }
        return $html;
    }

References ILIAS\Repository\ctrl(), and ilObjMediaObject\getMimeType().

Here is the call graph for this function:

renderMediaModal()

ilNewsTimelineItemGUI::renderMediaModal ( )

protected

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

                                         : string
    {
        $ui_factory = $this->gui->ui()->factory();
        $ui_renderer = $this->gui->ui()->renderer();
 
        if (isset($this->item_image[$this->news_item->getId()]) && isset($this->item_modal[$this->news_item->getId()])) {
            $modal = $this->item_modal[$this->news_item->getId()];
            return $ui_renderer->render($modal);
        }
 
        $media_path = $this->getMediaPath();
        $mime = ilObjMediaObject::getMimeType($media_path);
 
        $modal_html = "";
 
        if (in_array($mime, ["image/jpeg", "image/svg+xml", "image/gif", "image/png"])) {
            $title = $this->media_object->getTitle();
            $image = $ui_factory->image()->responsive($media_path, $title);
            $modal_page = $ui_factory->modal()->lightboxImagePage($image, $title);
            $modal = $ui_factory->modal()->lightbox($modal_page);
            $image = $image->withAction($modal->getShowSignal());
            $this->item_image[$this->news_item->getId()] = $image;
            $this->item_modal[$this->news_item->getId()] = $modal;
            $modal_html = $ui_renderer->render($modal);
        }
        return $modal_html;
    }

References ilObjMediaObject\getMimeType().

Here is the call 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 35 of file class.ilNewsTimelineItemGUI.php.

$gui

ILIAS News InternalGUIService ilNewsTimelineItemGUI::$gui

protected

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

$item_image

array ilNewsTimelineItemGUI::$item_image = []

protected

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

$item_modal

array ilNewsTimelineItemGUI::$item_modal = []

protected

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

$lng

ilLanguage ilNewsTimelineItemGUI::$lng

protected

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

$media_object

readonly ilObjMediaObject ilNewsTimelineItemGUI::$media_object

protected

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

$notes

ILIAS Notes Service ilNewsTimelineItemGUI::$notes

protected

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

$obj_def

ilObjectDefinition ilNewsTimelineItemGUI::$obj_def

protected

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

$ref_id

int ilNewsTimelineItemGUI::$ref_id

protected

Definition at line 34 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 32 of file class.ilNewsTimelineItemGUI.php.

$user_edit_all

bool ilNewsTimelineItemGUI::$user_edit_all

protected

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

---

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

• components/ILIAS/News/classes/class.ilNewsTimelineItemGUI.php