ILIAS\News\Data\NewsItem Class Reference

News Item DTO for transfer of news items. More...

Collaboration diagram for ILIAS\News\Data\NewsItem:

Public Member Functions
	__construct (protected int $id, protected string $title, protected string $content, protected int $context_obj_id, protected string $context_obj_type, protected int $context_sub_obj_id, protected ?string $context_sub_obj_type, protected string $content_type, protected \DateTimeImmutable $creation_date, protected \DateTimeImmutable $update_date, protected int $user_id, protected int $update_user_id, protected string $visibility, protected string $content_long, protected int $priority, protected bool $content_is_lang_var, protected bool $content_text_is_lang_var, protected int $mob_id, protected string $playtime, protected int $mob_cnt_play, protected int $mob_cnt_download, protected bool $content_html, protected int $context_ref_id=0)
	getId ()
	isContentTextIsLangVar ()
	getTitle ()
	getContent ()
	getContextObjId ()
	getContextRefId ()
	getContextObjType ()
	getContextSubObjId ()
	getContextSubObjType ()
	getContentType ()
	getCreationDate ()
	getUpdateDate ()
	getUserId ()
	getUpdateUserId ()
	getVisibility ()
	getContentLong ()
	getPriority ()
	isContentIsLangVar ()
	getMobId ()
	getPlaytime ()
	getMobCntPlay ()
	getMobCntDownload ()
	isContentHtml ()
	withContextRefId (int $context_ref_id)
	withContent (string $content)
	withContentLong (string $content_long)
	toArray ()
	toLegacy ()

Detailed Description

News Item DTO for transfer of news items.

Definition at line 28 of file NewsItem.php.

Constructor & Destructor Documentation

__construct()

ILIAS\News\Data\NewsItem::__construct	(	protected int	$id,
		protected string	$title,
		protected string	$content,
		protected int	$context_obj_id,
		protected string	$context_obj_type,
		protected int	$context_sub_obj_id,
		protected ?string	$context_sub_obj_type,
		protected string	$content_type,
		protected \DateTimeImmutable	$creation_date,
		protected \DateTimeImmutable	$update_date,
		protected int	$user_id,
		protected int	$update_user_id,
		protected string	$visibility,
		protected string	$content_long,
		protected int	$priority,
		protected bool	$content_is_lang_var,
		protected bool	$content_text_is_lang_var,
		protected int	$mob_id,
		protected string	$playtime,
		protected int	$mob_cnt_play,
		protected int	$mob_cnt_download,
		protected bool	$content_html,
		protected int	$context_ref_id = 0
	)

Definition at line 30 of file NewsItem.php.

      {
    }

Member Function Documentation

getContent()

ILIAS\News\Data\NewsItem::getContent

(

)

Definition at line 72 of file NewsItem.php.

                                : string
    {
        return $this->content;
    }

getContentLong()

ILIAS\News\Data\NewsItem::getContentLong

(

)

Definition at line 132 of file NewsItem.php.

                                    : string
    {
        return $this->content_long;
    }

getContentType()

ILIAS\News\Data\NewsItem::getContentType

(

)

Definition at line 102 of file NewsItem.php.

                                    : string
    {
        return $this->content_type;
    }

getContextObjId()

ILIAS\News\Data\NewsItem::getContextObjId

(

)

Definition at line 77 of file NewsItem.php.

                                     : int
    {
        return $this->context_obj_id;
    }

Referenced by ILIAS\News\Data\NewsCollection\addNewsItem(), and ILIAS\News\Data\NewsCollection\getGroupingFor().

Here is the caller graph for this function:

getContextObjType()

ILIAS\News\Data\NewsItem::getContextObjType

(

)

Definition at line 87 of file NewsItem.php.

                                       : string
    {
        return $this->context_obj_type;
    }

Referenced by ILIAS\News\Data\NewsCollection\addNewsItem(), and ILIAS\News\Data\NewsCollection\getGroupingFor().

Here is the caller graph for this function:

getContextRefId()

ILIAS\News\Data\NewsItem::getContextRefId

(

)

Definition at line 82 of file NewsItem.php.

                                     : int
    {
        return $this->context_ref_id;
    }

Referenced by ILIAS\News\Data\NewsCollection\getGroupingFor().

Here is the caller graph for this function:

getContextSubObjId()

ILIAS\News\Data\NewsItem::getContextSubObjId

(

)

Definition at line 92 of file NewsItem.php.

                                        : int
    {
        return $this->context_sub_obj_id;
    }

getContextSubObjType()

ILIAS\News\Data\NewsItem::getContextSubObjType

(

)

Definition at line 97 of file NewsItem.php.

                                          : ?string
    {
        return $this->context_sub_obj_type;
    }

getCreationDate()

ILIAS\News\Data\NewsItem::getCreationDate

(

)

Definition at line 107 of file NewsItem.php.

                                     : DateTimeImmutable
    {
        return $this->creation_date;
    }

getId()

ILIAS\News\Data\NewsItem::getId

(

)

Definition at line 57 of file NewsItem.php.

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by ILIAS\News\Data\NewsCollection\addNewsItem(), ILIAS\News\Data\NewsCollection\getGroupingFor(), ilNewsTimelineItemGUI\renderMedia(), and ilNewsTimelineItemGUI\renderMediaModal().

Here is the caller graph for this function:

getMobCntDownload()

ILIAS\News\Data\NewsItem::getMobCntDownload

(

)

Definition at line 162 of file NewsItem.php.

                                       : int
    {
        return $this->mob_cnt_download;
    }

getMobCntPlay()

ILIAS\News\Data\NewsItem::getMobCntPlay

(

)

Definition at line 157 of file NewsItem.php.

                                   : int
    {
        return $this->mob_cnt_play;
    }

getMobId()

ILIAS\News\Data\NewsItem::getMobId

(

)

Definition at line 147 of file NewsItem.php.

                              : int
    {
        return $this->mob_id;
    }

Referenced by ilNewsTimelineItemGUI\getMediaPath().

Here is the caller graph for this function:

getPlaytime()

ILIAS\News\Data\NewsItem::getPlaytime

(

)

Definition at line 152 of file NewsItem.php.

                                 : string
    {
        return $this->playtime;
    }

getPriority()

ILIAS\News\Data\NewsItem::getPriority

(

)

Definition at line 137 of file NewsItem.php.

                                 : int
    {
        return $this->priority;
    }

getTitle()

ILIAS\News\Data\NewsItem::getTitle

(

)

Definition at line 67 of file NewsItem.php.

                              : string
    {
        return $this->title;
    }

getUpdateDate()

ILIAS\News\Data\NewsItem::getUpdateDate

(

)

Definition at line 112 of file NewsItem.php.

                                   : DateTimeImmutable
    {
        return $this->update_date;
    }

getUpdateUserId()

ILIAS\News\Data\NewsItem::getUpdateUserId

(

)

Definition at line 122 of file NewsItem.php.

                                     : int
    {
        return $this->update_user_id;
    }

getUserId()

ILIAS\News\Data\NewsItem::getUserId

(

)

Definition at line 117 of file NewsItem.php.

                               : int
    {
        return $this->user_id;
    }

References $user_id.

getVisibility()

ILIAS\News\Data\NewsItem::getVisibility

(

)

Definition at line 127 of file NewsItem.php.

                                   : string
    {
        return $this->visibility;
    }

isContentHtml()

ILIAS\News\Data\NewsItem::isContentHtml

(

)

Definition at line 167 of file NewsItem.php.

                                   : bool
    {
        return $this->content_html;
    }

isContentIsLangVar()

ILIAS\News\Data\NewsItem::isContentIsLangVar

(

)

Definition at line 142 of file NewsItem.php.

                                        : bool
    {
        return $this->content_is_lang_var;
    }

isContentTextIsLangVar()

ILIAS\News\Data\NewsItem::isContentTextIsLangVar

(

)

Definition at line 62 of file NewsItem.php.

                                            : bool
    {
        return $this->content_text_is_lang_var;
    }

toArray()

ILIAS\News\Data\NewsItem::toArray

(

)

Definition at line 195 of file NewsItem.php.

                             : array
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'content' => $this->content,
            'context_obj_id' => $this->context_obj_id,
            'context_obj_type' => $this->context_obj_type,
            'context_sub_obj_id' => $this->context_sub_obj_id,
            'context_sub_obj_type' => $this->context_sub_obj_type,
            'content_type' => $this->content_type,
            'creation_date' => $this->creation_date->format('Y-m-d H:i:s'),
            'update_date' => $this->update_date->format('Y-m-d H:i:s'),
            'user_id' => $this->user_id,
            'update_user_id' => $this->update_user_id,
            'visibility' => $this->visibility,
            'content_long' => $this->content_long,
            'priority' => $this->priority,
            'content_is_lang_var' => $this->content_is_lang_var,
            'content_text_is_lang_var' => $this->content_text_is_lang_var,
            'mob_id' => $this->mob_id,
            'playtime' => $this->playtime,
            'mob_cnt_play' => $this->mob_cnt_play,
            'mob_cnt_download' => $this->mob_cnt_download,
            'content_html' => $this->content_html
        ];
    }

References $id, and $user_id.

toLegacy()

ILIAS\News\Data\NewsItem::toLegacy

(

)

Definition at line 223 of file NewsItem.php.

                              : \ilNewsItem
    {
        $item = new \ilNewsItem(0); //prevent database loading
        $item->setId($this->id);
        $item->setTitle($this->title);
        $item->setContent($this->content);
        $item->setContextObjId($this->context_obj_id);
        $item->setContextObjType($this->context_obj_type);
        $item->setContextSubObjId($this->context_sub_obj_id);
        $item->setContextSubObjType($this->context_sub_obj_type);
        $item->setContentType($this->content_type);
        $item->setCreationDate($this->creation_date->format('Y-m-d H:i:s'));
        $item->setUpdateDate($this->update_date->format('Y-m-d H:i:s'));
        $item->setUserId($this->user_id);
        $item->setUpdateUserId($this->update_user_id);
        $item->setVisibility($this->visibility);
        $item->setContentLong($this->content_long);
        $item->setPriority($this->priority);
        $item->setContentIsLangVar($this->content_is_lang_var);
        $item->setContentTextIsLangVar($this->content_text_is_lang_var);
        $item->setMobId($this->mob_id);
        $item->setPlaytime($this->playtime);
        $item->setMobPlayCounter($this->mob_cnt_play);
        $item->setMobDownloadCounter($this->mob_cnt_download);
        $item->setContentHtml($this->content_html);
        return $item;
    }

withContent()

ILIAS\News\Data\NewsItem::withContent

(

string

$content

)

Definition at line 180 of file NewsItem.php.

                                                : NewsItem
    {
        $clone = clone $this;
        $clone->content = $content;
        return $clone;
    }

Referenced by ILIAS\News\Data\NewsCollection\getGroupingFor().

Here is the caller graph for this function:

withContentLong()

ILIAS\News\Data\NewsItem::withContentLong

(

string

$content_long

)

Definition at line 187 of file NewsItem.php.

                                                         : NewsItem
    {
        $clone = clone $this;
        $clone->content_long = $content_long;
        return $clone;
    }

withContextRefId()

ILIAS\News\Data\NewsItem::withContextRefId

(

int

$context_ref_id

)

Definition at line 173 of file NewsItem.php.

                                                         : NewsItem
    {
        $clone = clone $this;
        $clone->context_ref_id = $context_ref_id;
        return $clone;
    }

---

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

• components/ILIAS/News/src/Data/NewsItem.php