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
ILIAS News InternalGUIService	$gui
ILIAS Notes Service	$notes
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
array	$item_image = []
array	$item_modal = []

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

References $DIC, ILIAS\Repository\ctrl(), 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 = $DIC->news()
            ->internal()
            ->gui()
            ->standardRequest();
        $this->ref_id = $this->std_request->getRefId();
        $this->gui = $DIC->news()
            ->internal()
            ->gui();
        $this->notes = $DIC->notes();
    }

Here is the call graph for this function:

Member Function Documentation

getDateTime()

ilNewsTimelineItemGUI::getDateTime

(

)

Get datetime.

Returns

ilDateTime timestamp

Implements ilTimelineItemInt.

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

References 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 74 of file class.ilNewsTimelineItemGUI.php.

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

     : 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 313 of file class.ilNewsTimelineItemGUI.php.

References ilNewsItem\getMobId(), and ilObjMediaObject\getStandardSrc().

Referenced by renderMedia(), and renderMediaModal().

                                                  : string
    {
        $media_path = "";
        if ($i->getMobId() > 0) {
            $mob = new ilObjMediaObject($i->getMobId());
            $media_path = $mob->getStandardSrc();
        }
        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 87 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 103 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 114 of file class.ilNewsTimelineItemGUI.php.

References $id, ilObject\_exists(), ilObject\_getIcon(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ilNewsItem\determineNewsTitle(), ilDatePresentation\formatDate(), getDateTime(), ilUserUtil\getNamePresentation(), getNewsItem(), ilNewsRendererFactory\getRenderer(), getUserEditAll(), IL_CAL_DATETIME, ILIAS\Repository\lng(), renderMedia(), ILIAS\Repository\user(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

                            : string
    {
        $i = $this->getNewsItem();
        $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($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();
        }

        $p = $this->gui->profile();
        $tpl->setVariable("USER_AVATAR", $this->gui->ui()->renderer()->render(
            $p->getAvatar($i->getUserId())
        ));
        $tpl->setVariable(
            "TITLE",
            ilNewsItem::determineNewsTitle($i->getContextObjType(), $i->getTitle(), $i->getContentIsLangVar())
        );

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

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

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

        // actions
        $actions = [];

        if ($i->getPriority() === 1 && ($i->getUserId() === $this->user->getId() || $this->getUserEditAll())) {
            if (!$news_renderer->preventEditing()) {
                $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();
    }

Here is the call graph for this function:

renderFooter()

ilNewsTimelineItemGUI::renderFooter

(

)

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

References ILIAS\Repository\ctrl(), getNewsItem(), and renderMediaModal().

                                  : 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();
        $comments_gui = $this->notes->gui()->getCommentsGUI(
            $i->getContextObjId(),
            $i->getContextSubObjId(),
            $notes_obj_type,
            $i->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", "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 209 of file class.ilNewsTimelineItemGUI.php.

References ILIAS\Repository\ctrl(), ilNewsItem\getId(), getMediaPath(), ilObjMediaObject\getMimeType(), and null.

Referenced by render().

                                                 : string
    {
        $media_path = $this->getMediaPath($i);
        $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[$i->getId()]) && isset($this->item_modal[$i->getId()])) {
                $image = $this->item_image[$i->getId()];
            } else {
                $title = basename($media_path);
                $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[$i->getId()] = $image;
                $this->item_modal[$i->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", "news_id", $i->getId());
            $link = $ui_factory->link()->standard(
                basename($media_path),
                $this->ctrl->getLinkTargetByClass("ilnewstimelinegui", "downloadMob")
            );
            $html = $ui_renderer->render($link);
            $this->ctrl->setParameterByClass("ilnewstimelinegui", "news_id", null);
        } else {
            $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 250 of file class.ilNewsTimelineItemGUI.php.

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

Referenced by renderFooter().

                                                      : string
    {
        $ui_factory = $this->gui->ui()->factory();
        $ui_renderer = $this->gui->ui()->renderer();

        if (isset($this->item_image[$i->getId()]) && isset($this->item_modal[$i->getId()])) {
            $modal = $this->item_modal[$i->getId()];
            return $ui_renderer->render($modal);
        }

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

        $modal_html = "";

        if (in_array($mime, ["image/jpeg", "image/svg+xml", "image/gif", "image/png"])) {
            $title = basename($media_path);
            $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[$i->getId()] = $image;
            $this->item_modal[$i->getId()] = $modal;
            $modal_html = $ui_renderer->render($modal);
        }
        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 82 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 95 of file class.ilNewsTimelineItemGUI.php.

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

Field Documentation

$ctrl

ilCtrl ilNewsTimelineItemGUI::$ctrl

protected

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

$gui

ILIAS News InternalGUIService ilNewsTimelineItemGUI::$gui

protected

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

$item_image

array ilNewsTimelineItemGUI::$item_image = []

protected

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

$item_modal

array ilNewsTimelineItemGUI::$item_modal = []

protected

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

$like_gui

ilLikeGUI ilNewsTimelineItemGUI::$like_gui

protected

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

$lng

ilLanguage ilNewsTimelineItemGUI::$lng

protected

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

$news_item

ilNewsItem ilNewsTimelineItemGUI::$news_item

protected

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

Referenced by getNewsItem().

$news_item_ref_id

int ilNewsTimelineItemGUI::$news_item_ref_id

protected

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

$notes

ILIAS Notes Service ilNewsTimelineItemGUI::$notes

protected

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

$std_request

StandardGUIRequest ilNewsTimelineItemGUI::$std_request

protected

Definition at line 38 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.

Referenced by getUserEditAll().

---

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

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