A news item can be created by different sources. More...

Collaboration diagram for ilNewsItem:

Public Member Functions
	__construct (int $a_id=0)

	setId (int $a_id)

	getId ()

	setTitle (string $a_title)

	getTitle ()

	setContent (string $a_content)

	getContent ()

	setContextObjId (int $a_context_obj_id)

	getContextObjId ()

	setContextObjType (string $a_context_obj_type)

	getContextObjType ()

	setContextSubObjId (int $a_context_sub_obj_id)

	getContextSubObjId ()

	setContextSubObjType (?string $a_context_sub_obj_type)

	getContextSubObjType ()

	setContentType (string $a_content_type="text")

	getContentType ()

	setCreationDate (string $a_creation_date)

	getCreationDate ()

	setUpdateDate (string $a_update_date)

	getUpdateDate ()

	setUserId (int $a_user_id)

	getUserId ()

	setUpdateUserId (int $a_val)

	getUpdateUserId ()

	setVisibility (string $a_visibility="users")

	getVisibility ()

	setContentLong (string $a_content_long)

	getContentLong ()

	setPriority (int $a_priority=1)

	getPriority ()

	setContentIsLangVar (bool $a_content_is_lang_var=false)

	getContentIsLangVar ()

	setMobId (int $a_mob_id)

	getMobId ()

	setPlaytime (string $a_playtime)

	getPlaytime ()

	setLimitation (bool $a_limitation)
	Set Limitation for number of items. More...

	getLimitation ()

	setContentTextIsLangVar (bool $a_val=false)

	getContentTextIsLangVar ()

	setMobPlayCounter (int $a_val)

	getMobPlayCounter ()

	setMobDownloadCounter (int $a_val)

	getMobDownloadCounter ()

	setContentHtml (bool $a_val)

	getContentHtml ()

	read ()
	Read item from database. More...

	create ()
	Create. More...

	update (bool $a_as_new=false)
	Update item in database. More...

	getNewsForRefId (int $a_ref_id, bool $a_only_public=false, bool $a_stopnesting=false, $a_time_period=0, bool $a_prevent_aggregation=true, bool $a_forum_group_sequences=false, bool $a_no_auto_generated=false, bool $a_ignore_date_filter=false, int $a_user_id=null, int $a_limit=0, array $a_excluded=[])
	Get News For Ref Id. More...

	getAggregatedNewsData (int $a_ref_id, bool $a_only_public=false, $a_time_period=0, bool $a_prevent_aggregation=false, string $a_starting_date="", bool $a_no_auto_generated=false, int $a_user_id=null, int $a_limit=0, array $a_exclude=[])
	Get news aggregation (e.g. More...

	setContext (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id=0, string $a_sub_obj_type="")
	Set context for news. More...

	queryNewsForContext (bool $a_for_rss_use=false, $a_time_period=0, string $a_starting_date="", bool $a_no_auto_generated=false, bool $a_oldest_first=false, int $a_limit=0, array $a_exclude=[])
	Query news for a context. More...

	checkNewsExistsForObjects (array $objects, $a_time_period=1)

	queryNewsForMultipleContexts (array $a_contexts, bool $a_for_rss_use=false, $a_time_period=0, string $a_starting_date="", bool $a_no_auto_generated=false, int $a_user_id=null, int $a_limit=0, array $a_exclude=[])

	delete ()
	Delete news item. More...

	deliverMobFile (string $a_purpose="Standard", bool $a_increase_download_cnt=false)
	Deliver mob file. More...

	increaseDownloadCounter ()
	Increase download counter. More...

	increasePlayCounter ()
	Increase play counter. More...

Static Public Member Functions
static	_getNewsItemsOfUser (int $a_user_id, bool $a_only_public=false, bool $a_prevent_aggregation=false, int $a_per=0, array &$a_cnt=[], bool $no_auto_generated=false, array $excluded=[], int $a_limit=0)
	Get all news items for a user. More...

static	queryNewsByIds (array $a_news_ids)
	Query news data by news ids. More...

static	_setRead (int $a_user_id, int $a_news_id)
	Set item read. More...

static	_setUnread (int $a_user_id, int $a_news_id)
	Set item unread. More...

static	mergeNews (array $n1, array $n2)
	Merges two sets of news. More...

static	_getDefaultVisibilityForRefId (int $a_ref_id)
	Get default visibility for reference id. More...

static	getNewsOfContext (int $a_context_obj_id, string $a_context_obj_type, int $a_context_sub_obj_id=0, string $a_context_sub_obj_type="")
	Get all news of a context. More...

static	deleteNewsOfContext (int $a_context_obj_id, string $a_context_obj_type, int $a_context_sub_obj_id=0, string $a_context_sub_obj_type="")
	Delete all news of a context. More...

static	_lookupTitle (int $a_news_id)
	Lookup News Title. More...

static	_lookupVisibility (int $a_news_id)
	Lookup News Visibility. More...

static	_lookupMobId (int $a_news_id)
	Lookup mob id. More...

static	filterObjIdsPerNews (array $a_obj_ids, $a_time_period=0, string $a_starting_date="", string $a_ending_date='', bool $ignore_period=false)
	Checks whether news are available for. More...

static	determineNewsTitleByNewsId (int $a_news_id, int $a_agg_ref_id=0, array $a_aggregation=[])
	Determine title for news item entry. More...

static	determineNewsTitle (string $a_context_obj_type, string $a_title, bool $a_content_is_lang_var, int $a_agg_ref_id=0, array $a_aggregation=[], ?ilLanguage $lng=null)
	Determine title for news item entry. More...

static	determineNewsContent (string $a_context_obj_type, string $a_content, bool $a_is_lang_var, ?ilLanguage $lng=null)
	Determine new content. More...

static	getFirstNewsIdForContext (int $a_context_obj_id, string $a_context_obj_type, int $a_context_sub_obj_id=0, string $a_context_sub_obj_type="")
	Get first new id of news set related to a certain context. More...

static	getLastNewsIdForContext (int $a_context_obj_id, string $a_context_obj_type, int $a_context_sub_obj_id=0, string $a_context_sub_obj_type="", bool $a_only_today=false)
	Get last news id of news set related to a certain context. More...

static	_lookupMediaObjectUsages (int $a_mob_id)
	Lookup media object usage(s) More...

static	_lookupContextObjId (int $a_news_id)
	Context Object ID. More...

static	_lookupDefaultPDPeriod ()

static	_lookupUserPDPeriod (int $a_user_id)

static	_lookupRSSPeriod ()

static	setPrivateFeedId (int $a_userId)

static	getPrivateFeedId ()

static	prepareNewsDataFromCache (array $a_cres)
	Prepare news data from cache. More...

Protected Member Functions
	aggregateForums (array $news, bool $a_group_posting_sequence=false)

	aggregateFiles (array $news, int $a_ref_id)

	getAggregatedChildNewsData (int $a_ref_id, bool $a_only_public=false, int $a_time_period=0, bool $a_prevent_aggregation=false, string $a_starting_date="", bool $a_no_auto_generated=false, array $a_excluded=[])
	Get news aggregation for child objects (e.g. More...

Static Protected Member Functions
static	handleTimePeriod ($a_time_period)
	Convert time period for DB-queries. More...

Protected Attributes
MediaObjectManager	$media_manager

int	$mob_cnt_play = 0

ilDBInterface	$db

ilTree	$tree

ilAccessHandler	$access

ilObjectDataCache	$obj_data_cache

ilObjUser	$user

ilLanguage	$lng

ilCtrl	$ctrl

int	$id = 0

string	$title = ""

string	$content = ""

bool	$content_html = false

int	$context_obj_id = 0

string	$context_obj_type = ""

int	$context_sub_obj_id = 0

string	$context_sub_obj_type = null

string	$content_type = "text"

string	$creation_date = ""

string	$update_date = ""

int	$user_id = 0

int	$update_user_id = 0

string	$visibility = "users"

string	$content_long = ""

int	$priority = 1

bool	$content_is_lang_var = false

int	$mob_id = 0

string	$playtime = ""

bool	$content_text_is_lang_var = false

ilLogger	$log

Private Attributes
int	$mob_cnt_download = 0

bool	$limitation = false

ilGlobalTemplateInterface	$main_tpl

Static Private Attributes
static int	$privFeedId = 0

Detailed Description

A news item can be created by different sources.

E.g. when a new forum posting is created, or when a change in a learning module is announced.

Please note that this class contains a lot of deprectated functions that will be move to other classes in the future. Please avoid to use these functions. This class should be a pure data class without persistence in the future.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilNewsItem::__construct ( int $a_id = 0 )

Definition at line 79 of file class.ilNewsItem.php.

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

     {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
 
         $this->db = $DIC->database();
         $this->tree = $DIC->repositoryTree();
         $this->access = $DIC->access();
         $this->obj_data_cache = $DIC["ilObjDataCache"];
         $this->user = $DIC->user();
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         if ($a_id > 0) {
             $this->setId($a_id);
             $this->read();
         }
         $this->limitation = true;
         $this->log = $DIC->logger()->news();
         $this->media_manager = $DIC->mediaObjects()->internal()->domain()->mediaObject();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getDefaultVisibilityForRefId()

static ilNewsItem::_getDefaultVisibilityForRefId ( int $a_ref_id )

static

Get default visibility for reference id.

Deprecated:: will move to ilNewsData

Definition at line 1386 of file class.ilNewsItem.php.

References $DIC, $path, $visibility, ilBlockSetting\_lookup(), ilTree\getPathFull(), and ilTree\isInTree().

Referenced by ilNewsForContextBlockGUI\addToSettingsForm(), createProperties(), ilObjForum\createSettings(), ilNewsItemGUI\getEditForm(), and ilNewsForContextBlockGUI\initSettingsForm().

                                                                        : string
     {
         global $DIC;
 
         $tree = $DIC->repositoryTree();
 
         $news_set = new ilSetting("news");
         $default_visibility = ($news_set->get("default_visibility") != "")
                 ? $news_set->get("default_visibility")
                 : "users";
 
         if ($tree->isInTree($a_ref_id)) {
             $path = $tree->getPathFull($a_ref_id);
 
             foreach ($path as $key => $row) {
                 if (!in_array($row["type"], ["root", "cat", "crs", "fold", "grp"], true)) {
                     continue;
                 }
 
                 $visibility = ilBlockSetting::_lookup(
                     "news",
                     "default_visibility",
                     0,
                     (int) $row["obj_id"]
                 );
 
                 if ($visibility != "") {
                     $default_visibility = $visibility;
                 }
             }
         }
 
         return $default_visibility;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getNewsItemsOfUser()

static ilNewsItem::_getNewsItemsOfUser	(	int	$a_user_id,
		bool	$a_only_public = `false`,
		bool	$a_prevent_aggregation = `false`,
		int	$a_per = `0`,
		array &	$a_cnt = `[]`,
		bool	$no_auto_generated = `false`,
		array	$excluded = `[]`,
		int	$a_limit = `0`
	)

static

Get all news items for a user.

Deprecated:: (will migrate to ilNewsData)

Definition at line 503 of file class.ilNewsItem.php.

References $data, $DIC, $ref_id, ilObject\_getAllReferences(), ilParticipants\_getMembershipByType(), ilObject\_lookupObjId(), ilObjUser\_lookupPref(), ilObject\_lookupType(), ILIAS\Repository\int(), and ilArrayUtil\sortArray().

Referenced by ilUserFeedWriter\__construct(), ILIAS\News\Dashboard\DashboardNewsManager\getContextOptions(), ILIAS\News\Timeline\TimelineManager\getNewsData(), ilPDNewsBlockGUI\getNewsData(), and ILIAS\News\Dashboard\DashboardNewsManager\getNewsForOverview().

      : array {
         global $DIC;
 
         $ilAccess = $DIC->access();
         $fav_rep = new ilFavouritesDBRepository();
 
         $news_item = new ilNewsItem();
 
         $per = $a_per;
 
         // this is currently not used
         $ref_ids = [];
 
         if (ilObjUser::_lookupPref($a_user_id, "pd_items_news") !== "n") {
             // get all items of the personal desktop
             $pd_items = $fav_rep->getFavouritesOfUser($a_user_id);
             foreach ($pd_items as $item) {
                 if (!in_array($item["ref_id"], $ref_ids)) {
                     $ref_ids[] = (int) $item["ref_id"];
                 }
             }
 
             // get all memberships
             $crs_mbs = ilParticipants::_getMembershipByType($a_user_id, ['crs']);
             $grp_mbs = ilParticipants::_getMembershipByType($a_user_id, ['grp']);
             $items = array_merge($crs_mbs, $grp_mbs);
             foreach ($items as $i) {
                 $item_references = ilObject::_getAllReferences($i);
                 if (is_array($item_references) && count($item_references)) {
                     foreach ($item_references as $ref_id) {
                         if (!in_array($ref_id, $ref_ids)) {
                             $ref_ids[] = $ref_id;
                         }
                     }
                 }
             }
         }
 
         $data = [];
 
         foreach ($ref_ids as $ref_id) {
             if (!$a_only_public) {
                 // this loop should not cost too much performance
                 $acc = $ilAccess->checkAccessOfUser($a_user_id, "read", "", $ref_id);
 
                 if (!$acc) {
                     continue;
                 }
             }
             if (self::getPrivateFeedId() > 0) {
                 global $DIC;
 
                 $rbacsystem = $DIC->rbac()->system();
                 $acc = $rbacsystem->checkAccessOfUser(self::getPrivateFeedId(), "read", $ref_id);
 
                 if (!$acc) {
                     continue;
                 }
             }
 
             $obj_id = ilObject::_lookupObjId($ref_id);
             $obj_type = ilObject::_lookupType($obj_id);
             $news = $news_item->getNewsForRefId(
                 $ref_id,
                 $a_only_public,
                 false,
                 $per,
                 $a_prevent_aggregation,
                 false,
                 $no_auto_generated,
                 false,
                 $a_user_id,
                 0,
                 $excluded
             );
 
             // counter
             if (!is_null($a_cnt)) {
                 $a_cnt[$ref_id] = count($news);
             }
 
             $data = self::mergeNews($data, $news);
         }
 
         $data = ilArrayUtil::sortArray($data, "creation_date", "desc", false, true);
 
         if ($a_limit > 0) {
             array_splice($data, $a_limit);
         }
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupContextObjId()

static ilNewsItem::_lookupContextObjId ( int $a_news_id )

static

Context Object ID.

Deprecated:: will move to ilNewsData

Definition at line 1821 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

Referenced by ilNewsItemGUI\executeCommand(), ilMediaObjectUsagesTableGUI\fillRow(), ilObjMediaObject\getParentObjectIdForUsage(), and ilNewsForContextBlockGUI\showNews().

                                                               : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT context_obj_id " .
             "FROM il_news_item " .
             "WHERE " .
                 " id = " . $ilDB->quote($a_news_id, "integer");
         $set = $ilDB->query($query);
         $rec = $ilDB->fetchAssoc($set);
 
         return $rec["context_obj_id"];
     }

Here is the caller graph for this function:

◆ _lookupDefaultPDPeriod()

static ilNewsItem::_lookupDefaultPDPeriod ( )

static

Deprecated:: will move to settings

Definition at line 1840 of file class.ilNewsItem.php.

Referenced by ilPDNewsBlockGUI\editSettings(), ILIAS\News\Dashboard\DashboardNewsManager\getPeriodOptions(), ilObjNewsSettingsGUI\getSettingsForm(), and ilPDNewsTableGUI\initFilter().

                                                    : int
     {
         $news_set = new ilSetting("news");
         $per = $news_set->get("pd_period");
         if ((int) $per === 0) {
             $per = 30;
         }
 
         return $per;
     }

Here is the caller graph for this function:

◆ _lookupMediaObjectUsages()

static ilNewsItem::_lookupMediaObjectUsages ( int $a_mob_id )

static

Lookup media object usage(s)

Deprecated:: will move to ilNewsData

Definition at line 1797 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

Referenced by ilObjMediaObject\lookupUsages().

                                                                   : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT id " .
             "FROM il_news_item " .
             "WHERE " .
                 " mob_id = " . $ilDB->quote($a_mob_id, "integer");
 
         $usages = [];
         $set = $ilDB->query($query);
         while ($rec = $ilDB->fetchAssoc($set)) {
             $usages[$rec["id"]] = ["type" => "news", "id" => $rec["id"]];
         }
 
         return $usages;
     }

Here is the caller graph for this function:

◆ _lookupMobId()

static ilNewsItem::_lookupMobId ( int $a_news_id )

static

Lookup mob id.

Deprecated:: will move to ilNewsData

Definition at line 1548 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

Referenced by ilNewsExporter\getXmlExportHeadDependencies().

                                                        : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT mob_id FROM il_news_item WHERE id = " .
             $ilDB->quote($a_news_id, "integer");
         $set = $ilDB->query($query);
         $rec = $ilDB->fetchAssoc($set);
         return (int) ($rec["mob_id"] ?? 0);
     }

Here is the caller graph for this function:

◆ _lookupRSSPeriod()

static ilNewsItem::_lookupRSSPeriod ( )

static

Deprecated:: will move to settings

Definition at line 1882 of file class.ilNewsItem.php.

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), and ilObjNewsSettingsGUI\getSettingsForm().

                                              : int
     {
         $news_set = new ilSetting("news");
         $rss_period = $news_set->get("rss_period");
         if ((int) $rss_period === 0) {          // default to two weeks
             $rss_period = 14;
         }
         return $rss_period;
     }

Here is the caller graph for this function:

◆ _lookupTitle()

static ilNewsItem::_lookupTitle ( int $a_news_id )

static

Lookup News Title.

Deprecated:: will move to ilNewsData

Definition at line 1513 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

                                                        : string
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT title FROM il_news_item WHERE id = " .
             $ilDB->quote($a_news_id, "integer");
         $set = $ilDB->query($query);
         $rec = $ilDB->fetchAssoc($set);
         return $rec["title"] ?? '';
     }

◆ _lookupUserPDPeriod()

static ilNewsItem::_lookupUserPDPeriod ( int $a_user_id )

static

Deprecated:: will move to settings->user

Definition at line 1854 of file class.ilNewsItem.php.

References ilBlockSetting\_lookup().

Referenced by ilPDNewsBlockGUI\editSettings(), ILIAS\News\Dashboard\DashboardNewsManager\getDashboardNewsPeriod(), ilPDNewsBlockGUI\getNewsData(), and ilPDNewsTableGUI\initFilter().

                                                               : int
     {
         $news_set = new ilSetting("news");
         $allow_shorter_periods = $news_set->get("allow_shorter_periods");
         $allow_longer_periods = $news_set->get("allow_longer_periods");
         $default_per = self::_lookupDefaultPDPeriod();
 
         $per = ilBlockSetting::_lookup(
             "pdnews",
             "news_pd_period",
             $a_user_id,
             0
         );
 
         // news period information
         if ($per <= 0 ||
             (!$allow_shorter_periods && ($per < $default_per)) ||
             (!$allow_longer_periods && ($per > $default_per))
         ) {
             $per = $default_per;
         }
 
         return (int) $per;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupVisibility()

static ilNewsItem::_lookupVisibility ( int $a_news_id )

static

Lookup News Visibility.

Deprecated:: will move to ilNewsData

Definition at line 1530 of file class.ilNewsItem.php.

References $DIC, $ilDB, and NEWS_USERS.

Referenced by ilObjMediaObjectAccess\checkAccessMob(), and ilMobStakeholder\checkAccessMobUsage().

                                                             : string
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT visibility FROM il_news_item WHERE id = " .
             $ilDB->quote($a_news_id, "integer");
         $set = $ilDB->query($query);
         $rec = $ilDB->fetchAssoc($set);
 
         return $rec["visibility"] ?? NEWS_USERS;
     }

Here is the caller graph for this function:

◆ _setRead()

static ilNewsItem::_setRead	(	int	$a_user_id,
		int	$a_news_id
	)

static

Set item read.

Deprecated:: will move to ilNewsData

Definition at line 1318 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

Referenced by ilNewsForContextBlockGUI\showNews().

      : void {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilAppEventHandler = $DIC["ilAppEventHandler"];
 
         $ilDB->replace(
             "il_news_read",
             [
                 "user_id" => ["integer", $a_user_id],
                 "news_id" => ["integer", $a_news_id]
             ],
             []
         );
 
         $ilAppEventHandler->raise(
             "components/ILIAS/News",
             "readNews",
             ["user_id" => $a_user_id, "news_ids" => [$a_news_id]]
         );
     }

Here is the caller graph for this function:

◆ _setUnread()

static ilNewsItem::_setUnread	(	int	$a_user_id,
		int	$a_news_id
	)

static

Set item unread.

Deprecated:: will move to ilNewsData

Definition at line 1347 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

      : void {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilAppEventHandler = $DIC["ilAppEventHandler"];
 
         $ilDB->manipulate("DELETE FROM il_news_read (user_id, news_id) VALUES (" .
             " WHERE user_id = " . $ilDB->quote($a_user_id, "integer") .
             " AND news_id = " . $ilDB->quote($a_news_id, "integer"));
 
         $ilAppEventHandler->raise(
             "components/ILIAS/News",
             "unreadNews",
             ["user_id" => $a_user_id, "news_ids" => [$a_news_id]]
         );
     }

◆ aggregateFiles()

ilNewsItem::aggregateFiles	(	array	$news,
		int	$a_ref_id
	)

protected

Deprecated:: will move to ilNewsData

Definition at line 890 of file class.ilNewsItem.php.

Referenced by getAggregatedChildNewsData(), and getAggregatedNewsData().

      : array {
         $first_file = "";
         $to_del = [];
         foreach ($news as $k => $v) {
             // aggregate file related news
             if ($v["context_obj_type"] === "file") {
                 if ($first_file === "") {
                     $first_file = $k;
                 } else {
                     $to_del[] = $k;
                 }
                 $news[$first_file]["aggregation"][$k] = $v;
                 $news[$first_file]["agg_ref_id"] = $a_ref_id;
                 $news[$first_file]["ref_id"] = $a_ref_id;
             }
         }
 
         foreach ($to_del as $v) {
             unset($news[$v]);
         }
 
         return $news;
     }

Here is the caller graph for this function:

◆ aggregateForums()

ilNewsItem::aggregateForums	(	array	$news,
		bool	$a_group_posting_sequence = `false`
	)

protected

Deprecated:: will move to ilNewsData

Definition at line 842 of file class.ilNewsItem.php.

Referenced by getNewsForRefId().

      : array {
         $to_del = [];
         $forums = [];
         $last_aggregation_forum = 0;
 
         // aggregate
         foreach ($news as $k => $v) {
             if ($a_group_posting_sequence && $last_aggregation_forum > 0 &&
                 $last_aggregation_forum != $v["context_obj_id"]) {
                 $forums[$last_aggregation_forum] = null;
             }
 
             if ($v["context_obj_type"] === "frm") {
                 if (!isset($forums[$v["context_obj_id"]])) {
                     // $forums[forum_id] = news_id;
                     $forums[$v["context_obj_id"]] = $k;
                     $last_aggregation_forum = $v["context_obj_id"];
                 } else {
                     $to_del[] = $k;
                 }
 
                 $news[$k]["no_context_title"] = true;
 
                 // aggregate every forum into it's "k" news
                 $news[$forums[$news[$k]["context_obj_id"]]]["aggregation"][$k]
                     = $news[$k];
                 $news[$k]["agg_ref_id"]
                     = $news[$k]["ref_id"];
                 $news[$k]["content"] = "";
                 $news[$k]["content_long"] = "";
             }
         }
 
         // delete double entries
         foreach ($to_del as $k) {
             unset($news[$k]);
         }
         //var_dump($news[14]["aggregation"]);
 
         return $news;
     }

Here is the caller graph for this function:

◆ checkNewsExistsForObjects()

ilNewsItem::checkNewsExistsForObjects	(	array	$objects,
			$a_time_period = `1`
	)

Deprecated:: will move to ilNewsData

Returns: int[]

Parameters

string | int $a_time_period

Definition at line 1186 of file class.ilNewsItem.php.

References $db, $ilDB, $q, and ILIAS\Repository\int().

      : array {
         $ilDB = $this->db;
 
         $all = [];
 
         $this->log->debug("time period: " . $a_time_period);
         $limit_ts = self::handleTimePeriod($a_time_period);
 
         // are there any news items for relevant objects and?
         $query = $ilDB->query($q = "SELECT id,context_obj_id,context_obj_type" .
             " FROM il_news_item" .
             " WHERE " . $ilDB->in("context_obj_id", array_keys($objects), false, "integer") .
             " AND creation_date >= " . $ilDB->quote($limit_ts, "timestamp"));
         $this->log->debug($q);
         while ($rec = $ilDB->fetchAssoc($query)) {
             if ($objects[$rec["context_obj_id"]]["type"] == $rec["context_obj_type"]) {
                 $all[] = (int) $rec["id"];
             }
         }
 
         return $all;
     }

Here is the call graph for this function:

◆ create()

ilNewsItem::create ( )

Create.

Deprecated:: (will migrate to ilNewsData or other class taking care of persistence)

Definition at line 384 of file class.ilNewsItem.php.

References $db, $ilDB, getContent(), getContentHtml(), getContentIsLangVar(), getContentLong(), getContentTextIsLangVar(), getContentType(), getContextObjId(), getContextObjType(), getContextSubObjId(), getContextSubObjType(), getId(), getLimitation(), getMobId(), getPlaytime(), getPriority(), getTitle(), getUpdateUserId(), getUserId(), getVisibility(), ilUtil\now(), and setId().

Referenced by ILIAS\News\Items\NewsItemManager\save().

                             : void
     {
         $ilDB = $this->db;
 
         // insert new record into db
         $this->setId($ilDB->nextId("il_news_item"));
         $ilDB->insert("il_news_item", [
             "id" => ["integer", $this->getId()],
             "title" => ["text", $this->getTitle()],
             "content" => ["clob", $this->getContent()],
             "content_html" => ["integer", (int) $this->getContentHtml()],
             "context_obj_id" => ["integer", $this->getContextObjId()],
             "context_obj_type" => ["text", $this->getContextObjType()],
             "context_sub_obj_id" => ["integer", $this->getContextSubObjId()],
             "context_sub_obj_type" => ["text", $this->getContextSubObjType()],
             "content_type" => ["text", $this->getContentType()],
             "creation_date" => ["timestamp", ilUtil::now()],
             "update_date" => ["timestamp", ilUtil::now()],
             "user_id" => ["integer", $this->getUserId()],
             "update_user_id" => ["integer", $this->getUpdateUserId()],
             "visibility" => ["text", $this->getVisibility()],
             "content_long" => ["clob", $this->getContentLong()],
             "priority" => ["integer", $this->getPriority()],
             "content_is_lang_var" => ["integer", $this->getContentIsLangVar()],
             "content_text_is_lang_var" => ["integer", (int) $this->getContentTextIsLangVar()],
             "mob_id" => ["integer", $this->getMobId()],
             "playtime" => ["text", $this->getPlaytime()]
         ]);
 
 
         $news_set = new ilSetting("news");
         $max_items = $news_set->get("max_items");
         if ($max_items <= 0) {
             $max_items = 50;
         }
 
         // limit number of news
         if ($this->getLimitation()) {
             // Determine how many rows should be deleted
             $query = "SELECT count(*) cnt " .
                 "FROM il_news_item " .
                 "WHERE " .
                     "context_obj_id = " . $ilDB->quote($this->getContextObjId(), "integer") .
                     " AND context_obj_type = " . $ilDB->quote($this->getContextObjType(), "text") .
                     " AND context_sub_obj_id = " . $ilDB->quote($this->getContextSubObjId(), "integer") .
                     " AND " . $ilDB->equals("context_sub_obj_type", $this->getContextSubObjType(), "text", true) . " ";
 
             $set = $ilDB->query($query);
             $rec = $ilDB->fetchAssoc($set);
 
             // if we have more records than allowed, delete them
             if (($rec["cnt"] > $max_items) && $this->getContextObjId() > 0) {
                 $query = "SELECT * " .
                     "FROM il_news_item " .
                     "WHERE " .
                         "context_obj_id = " . $ilDB->quote($this->getContextObjId(), "integer") .
                         " AND context_obj_type = " . $ilDB->quote($this->getContextObjType(), "text") .
                         " AND context_sub_obj_id = " . $ilDB->quote($this->getContextSubObjId(), "integer") .
                         " AND " . $ilDB->equals("context_sub_obj_type", $this->getContextSubObjType(), "text", true) .
                         " ORDER BY creation_date ASC";
 
                 $ilDB->setLimit($rec["cnt"] - $max_items, 0);
                 $del_set = $ilDB->query($query);
                 while ($del_item = $ilDB->fetchAssoc($del_set)) {
                     $del_news = new ilNewsItem((int) $del_item["id"]);
                     $del_news->delete();
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilNewsItem::delete ( )

Delete news item.

Deprecated:: will move to ilNewsData

Definition at line 1426 of file class.ilNewsItem.php.

References $db, $ilDB, ilObject\_exists(), getId(), and getMobId().

Referenced by ilNewsTimelineGUI\remove().

                             : void
     {
         $ilDB = $this->db;
 
         // delete il_news_read entries
         $ilDB->manipulate("DELETE FROM il_news_read " .
             " WHERE news_id = " . $ilDB->quote($this->getId(), "integer"));
 
         // delete multimedia object
         $mob = $this->getMobId();
 
         // delete
         $query = "DELETE FROM il_news_item" .
             " WHERE id = " . $ilDB->quote($this->getId(), "integer");
         $ilDB->manipulate($query);
 
         // delete mob after news, to have a "mob usage" of 0
         if ($mob > 0 && ilObject::_exists($mob)) {
             $mob = new ilObjMediaObject($mob);
             $mob->delete();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteNewsOfContext()

static ilNewsItem::deleteNewsOfContext	(	int	$a_context_obj_id,
		string	$a_context_obj_type,
		int	$a_context_sub_obj_id = `0`,
		string	$a_context_sub_obj_type = `""`
	)

static

Delete all news of a context.

Deprecated:: will move to ilNewsData

Definition at line 1493 of file class.ilNewsItem.php.

Referenced by ilObjTest\addToNewsOnOnline(), ilBlogPosting\delete(), ilPageObject\delete(), and ilBlogPosting\unpublish().

      : void {
         foreach (self::getNewsOfContext(
             $a_context_obj_id,
             $a_context_obj_type,
             $a_context_sub_obj_id,
             $a_context_sub_obj_type
         ) as $n) {
             $n->delete();
         }
     }

Here is the caller graph for this function:

◆ deliverMobFile()

ilNewsItem::deliverMobFile	(	string	$a_purpose = `"Standard"`,
		bool	$a_increase_download_cnt = `false`
	)

Deliver mob file.

Definition at line 1912 of file class.ilNewsItem.php.

References ilObjMediaObject\_getDirectory(), getMobId(), increaseDownloadCounter(), and ilUtil\redirect().

      : bool {
         $mob = $this->getMobId();
         $mob = new ilObjMediaObject($mob);
         $mob_dir = ilObjMediaObject::_getDirectory($mob->getId());
 
         // check purpose
         if (!$mob->hasPurposeItem($a_purpose)) {
             return false;
         }
 
         $m_item = $mob->getMediaItem($a_purpose);
         if ($m_item->getLocationType() !== "Reference") {
             $this->media_manager->deliverEntry($mob->getId(), "/" . $m_item->getLocation());
             if ($a_increase_download_cnt) {
                 $this->increaseDownloadCounter();
             }
             $this->main_tpl->setOnScreenMessage('failure', "File not found!", true);
             return false;
         }
 
         if ($a_increase_download_cnt) {
             $this->increaseDownloadCounter();
         }
 
         ilUtil::redirect($m_item->getLocation());
         return true;
     }

Here is the call graph for this function:

◆ determineNewsContent()

static ilNewsItem::determineNewsContent	(	string	$a_context_obj_type,
		string	$a_content,
		bool	$a_is_lang_var,
		?ilLanguage	$lng = `null`
	)

static

Determine new content.

Deprecated:: will move to util?

Definition at line 1698 of file class.ilNewsItem.php.

References $DIC, ilLanguage\loadLanguageModule(), ilObjectPlugin\lookupTxtById(), and ilLanguage\txt().

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), ilPDNewsTableGUI\fillRow(), ilNewsDefaultRendererGUI\getDetailContent(), and ilMembershipCronNotifications\run().

      : string {
         global $DIC;
 
         if (is_null($lng)) {
             $lng = $DIC->language();
         }
         $obj_definition = $DIC["objDefinition"];
 
         if ($a_is_lang_var) {
             if ($obj_definition->isPlugin($a_context_obj_type)) {
                 return ilObjectPlugin::lookupTxtById($a_context_obj_type, $a_content);
             }
             $lng->loadLanguageModule($a_context_obj_type);
             return $lng->txt($a_content);
         }
 
         return $a_content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineNewsTitle()

static ilNewsItem::determineNewsTitle	(	string	$a_context_obj_type,
		string	$a_title,
		bool	$a_content_is_lang_var,
		int	$a_agg_ref_id = `0`,
		array	$a_aggregation = `[]`,
		?ilLanguage	$lng = `null`
	)

static

Determine title for news item entry.

Deprecated:: will move to util?

Definition at line 1631 of file class.ilNewsItem.php.

References $DIC, ilObjectPlugin\lookupTxtById(), and ilLanguage\txt().

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), ilPDNewsTableGUI\fillRow(), ilNewsForContextBlockGUI\getInfoForData(), ilNewsTimelineItemGUI\render(), ilMembershipCronNotifications\run(), and ilNewsForContextBlockGUI\showNews().

      : string {
         global $DIC;
 
         if (is_null($lng)) {
             $lng = $DIC->language();
         }
         $obj_definition = $DIC["objDefinition"];
         $tit = "";
 
         if ($a_agg_ref_id > 0) {
             $cnt = count($a_aggregation);
 
             // forums
             if ($a_context_obj_type === "frm") {
                 if ($cnt > 1) {
                     return sprintf($lng->txt("news_x_postings"), $cnt);
                 }
 
                 return $lng->txt("news_1_postings");
             }
 
             // files
             $up_cnt = $cr_cnt = 0;
             foreach ($a_aggregation as $item) {
                 if ($item["title"] === "file_updated") {
                     $up_cnt++;
                 } else {
                     $cr_cnt++;
                 }
             }
             $sep = "";
             if ($cr_cnt === 1) {
                 $tit = $lng->txt("news_1_file_created");
                 $sep = "<br />";
             } elseif ($cr_cnt > 1) {
                 $tit = sprintf($lng->txt("news_x_files_created"), $cr_cnt);
                 $sep = "<br />";
             }
             if ($up_cnt === 1) {
                 $tit .= $sep . $lng->txt("news_1_file_updated");
             } elseif ($up_cnt > 1) {
                 $tit .= $sep . sprintf($lng->txt("news_x_files_updated"), $up_cnt);
             }
             return $tit;
         }
 
         if ($a_content_is_lang_var) {
             if ($obj_definition->isPlugin($a_context_obj_type)) {
                 return ilObjectPlugin::lookupTxtById($a_context_obj_type, $a_title);
             }
             return $lng->txt($a_title);
         }
 
         return $a_title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineNewsTitleByNewsId()

static ilNewsItem::determineNewsTitleByNewsId	(	int	$a_news_id,
		int	$a_agg_ref_id = `0`,
		array	$a_aggregation = `[]`
	)

static

Determine title for news item entry.

Definition at line 1604 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

      : string {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT context_obj_type, content_is_lang_var, title FROM il_news_item WHERE id = " .
             $ilDB->quote($a_news_id, "integer");
         $set = $ilDB->query($query);
         $rec = $ilDB->fetchAssoc($set);
 
         return self::determineNewsTitle(
             $rec["context_obj_type"],
             $rec["title"],
             $rec["content_is_lang_var"],
             $a_agg_ref_id,
             $a_aggregation
         );
     }

◆ filterObjIdsPerNews()

static ilNewsItem::filterObjIdsPerNews	(	array	$a_obj_ids,
			$a_time_period = `0`,
		string	$a_starting_date = `""`,
		string	$a_ending_date = `''`,
		bool	$ignore_period = `false`
	)

static

Checks whether news are available for.

Deprecated:: will move to ilNewsData

Parameters

array	$a_obj_ids
string \| int	$a_time_period

Definition at line 1567 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $and = "";
         if ($a_time_period > 0) {
             $limit_ts = self::handleTimePeriod($a_time_period);
             $and = " AND creation_date >= " . $ilDB->quote($limit_ts, "timestamp") . " ";
         }
 
         if ($a_starting_date !== "") {
             $and .= " AND creation_date >= " . $ilDB->quote($a_starting_date, "timestamp");
         }
 
         $query = "SELECT DISTINCT(context_obj_id) AS obj_id FROM il_news_item" .
             " WHERE " . $ilDB->in("context_obj_id", $a_obj_ids, false, "integer") . " " . $and;
         //" WHERE context_obj_id IN (".implode(ilUtil::quoteArray($a_obj_ids),",").")".$and;
 
         $set = $ilDB->query($query);
         $objs = [];
         while ($rec = $ilDB->fetchAssoc($set)) {
             $objs[] = $rec["obj_id"];
         }
 
         return $objs;
     }

◆ getAggregatedChildNewsData()

ilNewsItem::getAggregatedChildNewsData	(	int	$a_ref_id,
		bool	$a_only_public = `false`,
		int	$a_time_period = `0`,
		bool	$a_prevent_aggregation = `false`,
		string	$a_starting_date = `""`,
		bool	$a_no_auto_generated = `false`,
		array	$a_excluded = `[]`
	)

protected

Get news aggregation for child objects (e.g.

for categories)

Deprecated:: will move to ilNewsData

Definition at line 922 of file class.ilNewsItem.php.

References $access, $data, $ref_id, $tree, aggregateFiles(), ilTree\getChilds(), getNewsForRefId(), queryNewsForMultipleContexts(), and ilArrayUtil\sortArray().

Referenced by getNewsForRefId().

      : array {
         $tree = $this->tree;
         $ilAccess = $this->access;
         $ref_id = [];
         // get news of parent object
         $data = $this->getNewsForRefId(
             $a_ref_id,
             $a_only_public,
             true,
             $a_time_period,
             true,
             false,
             $a_no_auto_generated,
             false,
             null,
             0,
             $a_excluded
         );
         foreach ($data as $k => $v) {
             $data[$k]["ref_id"] = $a_ref_id;
         }
 
         // get childs
         $nodes = $tree->getChilds($a_ref_id);
 
         // no check, for which of the objects any news are available
         $obj_ids = [];
         foreach ($nodes as $node) {
             $obj_ids[] = $node["obj_id"];
         }
         $news_obj_ids = self::filterObjIdsPerNews($obj_ids, $a_time_period, $a_starting_date);
         //$news_obj_ids = $obj_ids;
 
         // get news for all subtree nodes
         $contexts = [];
         foreach ($nodes as $node) {
             // only go on, if news are available
             if (!in_array($node["obj_id"], $news_obj_ids)) {
                 continue;
             }
 
             if (!$a_only_public && !$ilAccess->checkAccess("read", "", (int) $node["child"])) {
                 continue;
             }
             $ref_id[$node["obj_id"]] = $node["child"];
             $contexts[] = [
                 "obj_id" => $node["obj_id"],
                 "obj_type" => $node["type"]
             ];
         }
 
         $news = $this->queryNewsForMultipleContexts(
             $contexts,
             $a_only_public,
             $a_time_period,
             $a_starting_date,
             $a_no_auto_generated,
             null,
             0,
             $a_excluded
         );
         foreach ($news as $k => $v) {
             $news[$k]["ref_id"] = $ref_id[$v["context_obj_id"]];
         }
         $data = self::mergeNews($data, $news);
 
         // sort and return
         $data = ilArrayUtil::sortArray($data, "creation_date", "desc", false, true);
 
         if (!$a_prevent_aggregation) {
             $data = $this->aggregateFiles($data, $a_ref_id);
         }
 
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAggregatedNewsData()

ilNewsItem::getAggregatedNewsData	(	int	$a_ref_id,
		bool	$a_only_public = `false`,
			$a_time_period = `0`,
		bool	$a_prevent_aggregation = `false`,
		string	$a_starting_date = `""`,
		bool	$a_no_auto_generated = `false`,
		int	$a_user_id = `null`,
		int	$a_limit = `0`,
		array	$a_exclude = `[]`
	)

Get news aggregation (e.g.

for courses, groups)

Deprecated:: (will migrate to ilNewsData)

Parameters

string | int $a_time_period

Definition at line 735 of file class.ilNewsItem.php.

References $access, $data, $obj_data_cache, $ref_id, $tree, aggregateFiles(), ilTree\getNodeData(), ilTree\getSubTree(), ILIAS\Repository\int(), ilObjectActivation\preloadData(), queryNewsForMultipleContexts(), and ilArrayUtil\sortArray().

Referenced by getNewsForRefId().

      : array {
         $tree = $this->tree;
         $ilAccess = $this->access;
         $ilObjDataCache = $this->obj_data_cache;
 
         // get news of parent object
         $data = [];
 
         // get subtree
         $cur_node = $tree->getNodeData($a_ref_id);
 
         // do not check for lft (materialized path)
         if ($cur_node) {
             $nodes = $tree->getSubTree($cur_node, true);
         } else {
             $nodes = [];
         }
 
         // preload object data cache
         $ref_ids = [];
         $obj_ids = [];
         $ref_id = [];
         foreach ($nodes as $node) {
             $ref_ids[] = (int) $node["child"];
             $obj_ids[] = (int) $node["obj_id"];
         }
 
         $ilObjDataCache->preloadReferenceCache($ref_ids);
         if (!$a_only_public) {
             ilObjectActivation::preloadData($ref_ids);
         }
 
         // no check, for which of the objects any news are available
         $news_obj_ids = self::filterObjIdsPerNews($obj_ids, $a_time_period, $a_starting_date);
         //$news_obj_ids = $obj_ids;
 
         // get news for all subtree nodes
         $contexts = [];
         foreach ($nodes as $node) {
             // only go on, if news are available
             if (!in_array($node["obj_id"], $news_obj_ids)) {
                 continue;
             }
 
             if (!$a_only_public) {
                 if (!$a_user_id) {
                     $acc = $ilAccess->checkAccess("read", "", (int) $node["child"]);
                 } else {
                     $acc = $ilAccess->checkAccessOfUser(
                         $a_user_id,
                         "read",
                         "",
                         (int) $node["child"]
                     );
                 }
                 if (!$acc) {
                     continue;
                 }
             }
 
             $ref_id[$node["obj_id"]] = $node["child"];
             $contexts[] = [
                 "obj_id" => $node["obj_id"],
                 "obj_type" => $node["type"]
             ];
         }
 
         // sort and return
         $news = $this->queryNewsForMultipleContexts(
             $contexts,
             $a_only_public,
             $a_time_period,
             $a_starting_date,
             $a_no_auto_generated,
             $a_user_id,
             $a_limit,
             $a_exclude
         );
 
         $to_del = [];
         foreach ($news as $k => $v) {
             $news[$k]["ref_id"] = $ref_id[$v["context_obj_id"]];
         }
 
         $data = self::mergeNews($data, $news);
         $data = ilArrayUtil::sortArray($data, "creation_date", "desc", false, true);
 
         if (!$a_prevent_aggregation) {
             $data = $this->aggregateFiles($data, $a_ref_id);
         }
 
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContent()

ilNewsItem::getContent ( )

Definition at line 125 of file class.ilNewsItem.php.

References $content.

Referenced by create(), and update().

                                 : string
     {
         return $this->content;
     }

Here is the caller graph for this function:

◆ getContentHtml()

ilNewsItem::getContentHtml ( )

Definition at line 339 of file class.ilNewsItem.php.

References $content_html.

Referenced by create(), and update().

                                     : bool
     {
         return $this->content_html;
     }

Here is the caller graph for this function:

◆ getContentIsLangVar()

ilNewsItem::getContentIsLangVar ( )

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

References $content_is_lang_var.

Referenced by create(), and update().

                                          : bool
     {
         return $this->content_is_lang_var;
     }

Here is the caller graph for this function:

◆ getContentLong()

ilNewsItem::getContentLong ( )

Definition at line 242 of file class.ilNewsItem.php.

References $content_long.

Referenced by create(), and update().

                                     : string
     {
         return $this->content_long;
     }

Here is the caller graph for this function:

◆ getContentTextIsLangVar()

ilNewsItem::getContentTextIsLangVar ( )

Definition at line 309 of file class.ilNewsItem.php.

References $content_text_is_lang_var.

Referenced by create(), and update().

                                              : bool
     {
         return $this->content_text_is_lang_var;
     }

Here is the caller graph for this function:

◆ getContentType()

ilNewsItem::getContentType ( )

Definition at line 175 of file class.ilNewsItem.php.

References $content_type.

Referenced by create(), and update().

                                     : string
     {
         return $this->content_type;
     }

Here is the caller graph for this function:

◆ getContextObjId()

ilNewsItem::getContextObjId ( )

Definition at line 135 of file class.ilNewsItem.php.

References $context_obj_id.

Referenced by create(), queryNewsForContext(), and update().

                                      : int
     {
         return $this->context_obj_id;
     }

Here is the caller graph for this function:

◆ getContextObjType()

ilNewsItem::getContextObjType ( )

Definition at line 145 of file class.ilNewsItem.php.

References $context_obj_type.

Referenced by create(), queryNewsForContext(), and update().

                                        : string
     {
         return $this->context_obj_type;
     }

Here is the caller graph for this function:

◆ getContextSubObjId()

ilNewsItem::getContextSubObjId ( )

Definition at line 155 of file class.ilNewsItem.php.

References $context_sub_obj_id.

Referenced by create(), queryNewsForContext(), and update().

                                         : int
     {
         return $this->context_sub_obj_id;
     }

Here is the caller graph for this function:

◆ getContextSubObjType()

ilNewsItem::getContextSubObjType ( )

Definition at line 165 of file class.ilNewsItem.php.

References $context_sub_obj_type.

Referenced by create(), queryNewsForContext(), and update().

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

Here is the caller graph for this function:

◆ getCreationDate()

ilNewsItem::getCreationDate ( )

Definition at line 185 of file class.ilNewsItem.php.

References $creation_date.

                                      : string
     {
         return $this->creation_date;
     }

◆ getFirstNewsIdForContext()

static ilNewsItem::getFirstNewsIdForContext	(	int	$a_context_obj_id,
		string	$a_context_obj_type,
		int	$a_context_sub_obj_id = `0`,
		string	$a_context_sub_obj_type = `""`
	)

static

Get first new id of news set related to a certain context.

Deprecated:: will move to ilNewsData

Definition at line 1726 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

Referenced by ilObjTest\addToNewsOnOnline(), ilForum\deletePost(), ilForumTopic\movePosts(), ilForum\postCensorship(), and ilObjForumGUI\savePostObject().

      : int {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         // Determine how many rows should be deleted
         $query = "SELECT id " .
             "FROM il_news_item " .
             "WHERE " .
                 "context_obj_id = " . $ilDB->quote($a_context_obj_id, "integer") .
                 " AND context_obj_type = " . $ilDB->quote($a_context_obj_type, "text") .
                 " AND context_sub_obj_id = " . $ilDB->quote($a_context_sub_obj_id, "integer") .
                 " AND " . $ilDB->equals("context_sub_obj_type", $a_context_sub_obj_type, "text", true);
 
         $set = $ilDB->query($query);
         $rec = $ilDB->fetchAssoc($set);
 
         return (int) ($rec["id"] ?? 0);
     }

Here is the caller graph for this function:

◆ getId()

ilNewsItem::getId ( )

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

References $id.

Referenced by create(), delete(), ilObjMediaCastGUI\determinePlaytimeObject(), increaseDownloadCounter(), increasePlayCounter(), read(), ilNewsTimelineItemGUI\renderMedia(), ilNewsTimelineItemGUI\renderMediaModal(), ILIAS\News\Items\NewsItemManager\save(), and update().

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getLastNewsIdForContext()

static ilNewsItem::getLastNewsIdForContext	(	int	$a_context_obj_id,
		string	$a_context_obj_type,
		int	$a_context_sub_obj_id = `0`,
		string	$a_context_sub_obj_type = `""`,
		bool	$a_only_today = `false`
	)

static

Get last news id of news set related to a certain context.

Deprecated:: will move to ilNewsData

Definition at line 1755 of file class.ilNewsItem.php.

References $DIC, $id, $ilDB, ILIAS\Repository\int(), and ilUtil\now().

Referenced by ilBlogPosting\handleNews(), and ilWikiPage\updateNews().

      : int {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         // Determine how many rows should be deleted
         $query = "SELECT id, update_date " .
             "FROM il_news_item " .
             "WHERE " .
                 "context_obj_id = " . $ilDB->quote($a_context_obj_id, "integer") .
                 " AND context_obj_type = " . $ilDB->quote($a_context_obj_type, "text") .
                 " AND context_sub_obj_id = " . $ilDB->quote($a_context_sub_obj_id, "integer") .
                 " AND " . $ilDB->equals("context_sub_obj_type", $a_context_sub_obj_type, "text", true) .
             " ORDER BY update_date DESC";
 
         $ilDB->setLimit(1, 0);
         $set = $ilDB->query($query);
         $id = 0;
         if ($rec = $ilDB->fetchAssoc($set)) {
             $id = (int) $rec["id"];
             if ($a_only_today) {
                 $now = ilUtil::now();
                 if (strpos($rec["update_date"], substr($now, 0, 10)) !== 0) {
                     $id = 0;
                 }
             }
         }
 
         return $id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLimitation()

ilNewsItem::getLimitation ( )

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

References $limitation.

Referenced by create().

                                    : bool
     {
         return $this->limitation;
     }

Here is the caller graph for this function:

◆ getMobDownloadCounter()

ilNewsItem::getMobDownloadCounter ( )

Definition at line 329 of file class.ilNewsItem.php.

References $mob_cnt_download.

Referenced by increaseDownloadCounter(), and update().

                                            : int
     {
         return $this->mob_cnt_download;
     }

Here is the caller graph for this function:

◆ getMobId()

ilNewsItem::getMobId ( )

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

References $mob_id.

Referenced by create(), delete(), deliverMobFile(), ilObjMediaCastGUI\determinePlaytimeObject(), ilNewsTimelineItemGUI\getMediaPath(), ilObjMediaCastGUI\initAddCastItemForm(), update(), and ilObjMediaCastGUI\updateCastItemObject().

                               : int
     {
         return $this->mob_id;
     }

Here is the caller graph for this function:

◆ getMobPlayCounter()

ilNewsItem::getMobPlayCounter ( )

Definition at line 319 of file class.ilNewsItem.php.

References $mob_cnt_play.

Referenced by increasePlayCounter(), and update().

                                        : int
     {
         return $this->mob_cnt_play;
     }

Here is the caller graph for this function:

◆ getNewsForRefId()

ilNewsItem::getNewsForRefId	(	int	$a_ref_id,
		bool	$a_only_public = `false`,
		bool	$a_stopnesting = `false`,
			$a_time_period = `0`,
		bool	$a_prevent_aggregation = `true`,
		bool	$a_forum_group_sequences = `false`,
		bool	$a_no_auto_generated = `false`,
		bool	$a_ignore_date_filter = `false`,
		int	$a_user_id = `null`,
		int	$a_limit = `0`,
		array	$a_excluded = `[]`
	)

Get News For Ref Id.

Deprecated:: (will migrate to ilNewsData)

Parameters

string \| int	$a_time_period
int	$a_limit	currently only supported for groups and courses
	int[]	$a_excluded currently only supported for groups and courses (news ids)

Definition at line 612 of file class.ilNewsItem.php.

References ilBlockSetting\_lookup(), ilContainer\_lookupContainerSetting(), ilObject\_lookupObjId(), ilObject\_lookupType(), aggregateForums(), getAggregatedChildNewsData(), getAggregatedNewsData(), and NEWS_PUBLIC.

Referenced by getAggregatedChildNewsData(), and ilNewsItemGUI\getNewsForContextTable().

      : array {
         $obj_id = ilObject::_lookupObjId($a_ref_id);
         $obj_type = ilObject::_lookupType($obj_id);
 
         // get starting date
         $starting_date = "";
         if ($obj_type === "grp" || $obj_type === "crs") {
             // see #31471, #30687, and ilMembershipNotification
             if (!ilContainer::_lookupContainerSetting(
                 $obj_id,
                 'cont_use_news',
                 '1'
             ) || (
                 !ilContainer::_lookupContainerSetting(
                     $obj_id,
                     'cont_show_news',
                     '1'
                 ) && !ilContainer::_lookupContainerSetting(
                     $obj_id,
                     'news_timeline'
                 )
             )) {
                 return [];
             }
 
             $hide_news_per_date = ilBlockSetting::_lookup(
                 "news",
                 "hide_news_per_date",
                 0,
                 $obj_id
             );
             if ($hide_news_per_date && !$a_ignore_date_filter) {
                 $starting_date = ilBlockSetting::_lookup(
                     "news",
                     "hide_news_date",
                     0,
                     $obj_id
                 );
             }
         }
 
         if ($obj_type === "cat" && !$a_stopnesting) {
             $news = $this->getAggregatedChildNewsData(
                 $a_ref_id,
                 $a_only_public,
                 $a_time_period,
                 $a_prevent_aggregation,
                 $starting_date,
                 $a_no_auto_generated,
                 $a_excluded
             );
         } elseif (($obj_type === "grp" || $obj_type === "crs") &&
             !$a_stopnesting) {
             $news = $this->getAggregatedNewsData(
                 $a_ref_id,
                 $a_only_public,
                 $a_time_period,
                 $a_prevent_aggregation,
                 $starting_date,
                 $a_no_auto_generated,
                 $a_user_id,
                 $a_limit,
                 $a_excluded
             );
         } else {
             $news_item = new ilNewsItem();
             $news_item->setContextObjId($obj_id);
             $news_item->setContextObjType($obj_type);
             $news = $news_item->queryNewsForContext(
                 $a_only_public,
                 $a_time_period,
                 $starting_date,
                 $a_no_auto_generated,
                 false,
                 0,
                 $a_excluded
             );
             $unset = [];
             foreach ($news as $k => $v) {
                 if (!$a_only_public || $v["visibility"] == NEWS_PUBLIC ||
                     ($v["priority"] == 0 &&
                         ilBlockSetting::_lookup(
                             "news",
                             "public_notifications",
                             0,
                             $obj_id
                         ))) {
                     $news[$k]["ref_id"] = $a_ref_id;
                 } else {
                     $unset[] = $k;
                 }
             }
             foreach ($unset as $un) {
                 unset($news[$un]);
             }
         }
 
         if (!$a_prevent_aggregation) {
             $news = $this->aggregateForums($news);
         } elseif ($a_forum_group_sequences) {
             $news = $this->aggregateForums($news, true);
         }
 
         return $news;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNewsOfContext()

static ilNewsItem::getNewsOfContext	(	int	$a_context_obj_id,
		string	$a_context_obj_type,
		int	$a_context_sub_obj_id = `0`,
		string	$a_context_sub_obj_type = `""`
	)

static

Get all news of a context.

Deprecated:: will move to ilNewsData

Returns: ilNewsItem[]

Definition at line 1454 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
         $and = "";
 
         if ($a_context_obj_id === 0 || $a_context_obj_type === "") {
             return [];
         }
 
         if ($a_context_sub_obj_id > 0) {
             $and = " AND context_sub_obj_id = " . $ilDB->quote($a_context_sub_obj_id, "integer") .
                 " AND context_sub_obj_type = " . $ilDB->quote($a_context_sub_obj_type, "text");
         }
 
         // get news records
         $query = "SELECT id FROM il_news_item" .
             " WHERE context_obj_id = " . $ilDB->quote($a_context_obj_id, "integer") .
             " AND context_obj_type = " . $ilDB->quote($a_context_obj_type, "text") .
             $and;
 
         $news_set = $ilDB->query($query);
 
         $news_arr = [];
         while ($news = $ilDB->fetchAssoc($news_set)) {
             $news_arr[] = new ilNewsItem((int) $news["id"]);
         }
         return $news_arr;
     }

◆ getPlaytime()

ilNewsItem::getPlaytime ( )

Definition at line 286 of file class.ilNewsItem.php.

References $playtime.

Referenced by create(), and update().

                                  : string
     {
         return $this->playtime;
     }

Here is the caller graph for this function:

◆ getPriority()

ilNewsItem::getPriority ( )

Definition at line 252 of file class.ilNewsItem.php.

References $priority.

Referenced by ILIAS\News\Access\NewsAccess\canEdit(), create(), and update().

                                  : int
     {
         return $this->priority;
     }

Here is the caller graph for this function:

◆ getPrivateFeedId()

static ilNewsItem::getPrivateFeedId ( )

static

Deprecated:: will move to settings->user

Definition at line 1903 of file class.ilNewsItem.php.

                                              : int
     {
         return self::$privFeedId;
     }

◆ getTitle()

ilNewsItem::getTitle ( )

Definition at line 115 of file class.ilNewsItem.php.

References $title.

Referenced by create(), and update().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getUpdateDate()

ilNewsItem::getUpdateDate ( )

Definition at line 195 of file class.ilNewsItem.php.

References $update_date.

                                    : string
     {
         return $this->update_date;
     }

◆ getUpdateUserId()

ilNewsItem::getUpdateUserId ( )

Definition at line 215 of file class.ilNewsItem.php.

References $update_user_id.

Referenced by create(), and update().

                                      : int
     {
         return $this->update_user_id;
     }

Here is the caller graph for this function:

◆ getUserId()

ilNewsItem::getUserId ( )

Definition at line 205 of file class.ilNewsItem.php.

References $user_id.

Referenced by ILIAS\News\Access\NewsAccess\canEdit(), create(), and update().

                                : int
     {
         return $this->user_id;
     }

Here is the caller graph for this function:

◆ getVisibility()

ilNewsItem::getVisibility ( )

Definition at line 229 of file class.ilNewsItem.php.

References $visibility.

Referenced by create(), and update().

                                    : string
     {
         return $this->visibility;
     }

Here is the caller graph for this function:

◆ handleTimePeriod()

static ilNewsItem::handleTimePeriod ( $a_time_period )

staticprotected

Convert time period for DB-queries.

Parameters

string | int $a_time_period

Definition at line 1025 of file class.ilNewsItem.php.

                                                               : string
     {
         // time period is number of days
         if (is_numeric($a_time_period)) {
             if ($a_time_period > 0) {
                 return date('Y-m-d H:i:s', time() - ($a_time_period * 24 * 60 * 60));
             }
         }
         // time period is datetime
         elseif (preg_match("/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/", $a_time_period)) {
             return $a_time_period;
         }
         return "";
     }

◆ increaseDownloadCounter()

ilNewsItem::increaseDownloadCounter ( )

Increase download counter.

Deprecated:: will move to data

Definition at line 1947 of file class.ilNewsItem.php.

References $db, $ilDB, getId(), getMobDownloadCounter(), and setMobDownloadCounter().

Referenced by deliverMobFile().

                                              : void
     {
         $ilDB = $this->db;
 
         $cnt = $this->getMobDownloadCounter();
         $cnt++;
         $this->setMobDownloadCounter($cnt);
         $ilDB->manipulate(
             "UPDATE il_news_item SET " .
             " mob_cnt_download = " . $ilDB->quote($cnt, "integer") .
             " WHERE id = " . $ilDB->quote($this->getId(), "integer")
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ increasePlayCounter()

ilNewsItem::increasePlayCounter ( )

Increase play counter.

Deprecated:: will move to data

Definition at line 1966 of file class.ilNewsItem.php.

References $db, $ilDB, getId(), getMobPlayCounter(), and setMobPlayCounter().

                                          : void
     {
         $ilDB = $this->db;
 
         $cnt = $this->getMobPlayCounter();
         $cnt++;
         $this->setMobPlayCounter($cnt);
         $ilDB->manipulate(
             "UPDATE il_news_item SET " .
             " mob_cnt_play = " . $ilDB->quote($cnt, "integer") .
             " WHERE id = " . $ilDB->quote($this->getId(), "integer")
         );
     }

Here is the call graph for this function:

◆ mergeNews()

static ilNewsItem::mergeNews	(	array	$n1,
		array	$n2
	)

static

Merges two sets of news.

Deprecated:: will move to ilNewsData

Definition at line 1371 of file class.ilNewsItem.php.

References $id.

      : array {
         foreach ($n2 as $id => $news) {
             $n1[$id] = $news;
         }
 
         return $n1;
     }

◆ prepareNewsDataFromCache()

static ilNewsItem::prepareNewsDataFromCache ( array $a_cres )

static

Prepare news data from cache.

Deprecated:: will move to data

Definition at line 1984 of file class.ilNewsItem.php.

References $data, $DIC, $ilDB, and ILIAS\Repository\int().

Referenced by ilPDNewsBlockGUI\__construct(), and ilNewsForContextBlockGUI\__construct().

                                                                   : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $data = $a_cres;
         $news_ids = array_keys($data);
         $set = $ilDB->query("SELECT id FROM il_news_item " .
             " WHERE " . $ilDB->in("id", $news_ids, false, "integer"));
         $existing_ids = [];
         while ($rec = $ilDB->fetchAssoc($set)) {
             $existing_ids[] = (int) $rec["id"];
         }
         //var_dump($existing_ids);
         $existing_news = [];
         foreach ($data as $k => $v) {
             if (in_array($k, $existing_ids)) {
                 $existing_news[$k] = $v;
             }
         }
 
         return $existing_news;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ queryNewsByIds()

static ilNewsItem::queryNewsByIds ( array $a_news_ids )

static

Query news data by news ids.

Parameters

int[] $a_news_ids

Returns: array[]

Definition at line 1168 of file class.ilNewsItem.php.

References $DIC, and $ilDB.

Referenced by ilMembershipCronNotificationsData\loadMissingNews().

                                                             : array
     {
         global $DIC;
         $ilDB = $DIC->database();
         $news = [];
         $set = $ilDB->query("SELECT * FROM il_news_item " .
             " WHERE " . $ilDB->in("id", $a_news_ids, false, "integer"));
         while ($rec = $ilDB->fetchAssoc($set)) {
             $news[$rec["id"]] = $rec;
         }
         return $news;
     }

Here is the caller graph for this function:

◆ queryNewsForContext()

ilNewsItem::queryNewsForContext	(	bool	$a_for_rss_use = `false`,
			$a_time_period = `0`,
		string	$a_starting_date = `""`,
		bool	$a_no_auto_generated = `false`,
		bool	$a_oldest_first = `false`,
		int	$a_limit = `0`,
		array	$a_exclude = `[]`
	)

Query news for a context.

Deprecated:: will move to ilNewsData

Parameters

string | int $a_time_period

Definition at line 1045 of file class.ilNewsItem.php.

References $db, $ilDB, $user, ilBlockSetting\_lookup(), getContextObjId(), getContextObjType(), getContextSubObjId(), getContextSubObjType(), ILIAS\Repository\int(), and NEWS_PUBLIC.

Referenced by ilNewsItemGUI\getNewsForContextBlock(), and ilNewsItemGUI\getNewsForContextTable().

      : array {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         $and = "";
         if ($a_time_period > 0) {
             $limit_ts = self::handleTimePeriod($a_time_period);
             $and = " AND creation_date >= " . $ilDB->quote($limit_ts, "timestamp") . " ";
         }
 
         if ($a_starting_date !== "") {
             $and .= " AND creation_date > " . $ilDB->quote($a_starting_date, "timestamp") . " ";
         }
 
         if ($a_no_auto_generated) {
             $and .= " AND priority = 1 AND content_type = " . $ilDB->quote("text", "text") . " ";
         }
 
         // this is changed with 4.1 (news table for lm pages)
         if ($this->getContextSubObjId() > 0) {
             $and .= " AND context_sub_obj_id = " . $ilDB->quote($this->getContextSubObjId(), "integer") .
                 " AND context_sub_obj_type = " . $ilDB->quote($this->getContextSubObjType(), "text");
         }
 
         if (count($a_exclude) > 0) {
             $and .= " AND " . $ilDB->in("id", $a_exclude, true, "integer") . " ";
         }
 
         $ordering = ($a_oldest_first)
             ? " creation_date ASC, id ASC "
             : " creation_date DESC, id DESC ";
 
         if ($a_for_rss_use && self::getPrivateFeedId() === 0) {
             $query = "SELECT * " .
                 "FROM il_news_item " .
                 " WHERE " .
                     "context_obj_id = " . $ilDB->quote($this->getContextObjId(), "integer") .
                     " AND context_obj_type = " . $ilDB->quote($this->getContextObjType(), "text") .
                     $and .
                     " ORDER BY " . $ordering;
         } elseif (self::getPrivateFeedId() > 0) {
             $query = "SELECT il_news_item.* " .
                 ", il_news_read.user_id user_read " .
                 "FROM il_news_item LEFT JOIN il_news_read " .
                 "ON il_news_item.id = il_news_read.news_id AND " .
                 " il_news_read.user_id = " . $ilDB->quote(self::getPrivateFeedId(), "integer") .
                 " WHERE " .
                     "context_obj_id = " . $ilDB->quote($this->getContextObjId(), "integer") .
                     " AND context_obj_type = " . $ilDB->quote($this->getContextObjType(), "text") .
                     $and .
                     " ORDER BY " . $ordering;
         } else {
             $query = "SELECT il_news_item.* " .
                 ", il_news_read.user_id as user_read " .
                 "FROM il_news_item LEFT JOIN il_news_read " .
                 "ON il_news_item.id = il_news_read.news_id AND " .
                 " il_news_read.user_id = " . $ilDB->quote($ilUser->getId(), "integer") .
                 " WHERE " .
                     "context_obj_id = " . $ilDB->quote($this->getContextObjId(), "integer") .
                     " AND context_obj_type = " . $ilDB->quote($this->getContextObjType(), "text") .
                     $and .
                     " ORDER BY " . $ordering;
         }
         //echo $query;
         $set = $ilDB->query($query);
         $result = [];
         while ($rec = $ilDB->fetchAssoc($set)) {
             if ($a_limit > 0 && count($result) >= $a_limit) {
                 continue;
             }
             if (!$a_for_rss_use || (self::getPrivateFeedId() > 0) || ($rec["visibility"] === NEWS_PUBLIC ||
                 ((int) $rec["priority"] === 0 &&
                 ilBlockSetting::_lookup(
                     "news",
                     "public_notifications",
                     0,
                     (int) $rec["context_obj_id"]
                 )))) {
                 $result[$rec["id"]] = $rec;
             }
         }
 
         // do we get data for rss and may the time limit by an issue?
         // do a second query without time limit.
         // this is not very performant, but I do not have a better
         // idea. The keep_rss_min setting is currently (Jul 2012) only set
         // by mediacasts
         if ($a_time_period && $a_for_rss_use) {
             $keep_rss_min = ilBlockSetting::_lookup(
                 "news",
                 "keep_rss_min",
                 0,
                 $this->getContextObjId()
             );
             if ($keep_rss_min > 0) {
                 return $this->queryNewsForContext(
                     true,
                     0,
                     $a_starting_date,
                     $a_no_auto_generated,
                     $a_oldest_first,
                     (int) $keep_rss_min,
                     $a_exclude
                 );
             }
         }
 
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ queryNewsForMultipleContexts()

ilNewsItem::queryNewsForMultipleContexts	(	array	$a_contexts,
		bool	$a_for_rss_use = `false`,
			$a_time_period = `0`,
		string	$a_starting_date = `""`,
		bool	$a_no_auto_generated = `false`,
		int	$a_user_id = `null`,
		int	$a_limit = `0`,
		array	$a_exclude = `[]`
	)

Deprecated:: will move to ilNewsData

Parameters

string | int $a_time_period

Definition at line 1216 of file class.ilNewsItem.php.

References $db, $ilDB, $user, ilBlockSetting\_lookup(), ILIAS\Repository\int(), and NEWS_PUBLIC.

Referenced by getAggregatedChildNewsData(), and getAggregatedNewsData().

      : array {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         $and = "";
         if ($a_time_period > 0) {
             $limit_ts = self::handleTimePeriod($a_time_period);
             $and = " AND creation_date >= " . $ilDB->quote($limit_ts, "timestamp") . " ";
         }
 
         if ($a_starting_date !== "") {
             $and .= " AND creation_date > " . $ilDB->quote($a_starting_date, "timestamp") . " ";
         }
 
         if ($a_no_auto_generated) {
             $and .= " AND priority = 1 AND content_type = " . $ilDB->quote("text", "text") . " ";
         }
 
         if ($a_limit > 0) {
             $ilDB->setLimit($a_limit, 0);
         }
 
         if (is_array($a_exclude) && count($a_exclude) > 0) {
             $and .= " AND " . $ilDB->in("id", $a_exclude, true, "integer") . " ";
         }
 
         $ids = [];
         $type = [];
 
         foreach ($a_contexts as $cont) {
             $ids[] = $cont["obj_id"];
             $type[$cont["obj_id"]] = $cont["obj_type"];
         }
 
         if ($a_for_rss_use && self::getPrivateFeedId() === 0) {
             $query = "SELECT * " .
                 "FROM il_news_item " .
                 " WHERE " .
                     $ilDB->in("context_obj_id", $ids, false, "integer") . " " .
                     $and .
                     " ORDER BY creation_date DESC ";
         } elseif (self::getPrivateFeedId() > 0) {
             $query = "SELECT il_news_item.* " .
                 ", il_news_read.user_id as user_read " .
                 "FROM il_news_item LEFT JOIN il_news_read " .
                 "ON il_news_item.id = il_news_read.news_id AND " .
                 " il_news_read.user_id = " . $ilDB->quote(self::getPrivateFeedId(), "integer") .
                 " WHERE " .
                     $ilDB->in("context_obj_id", $ids, false, "integer") . " " .
                     $and .
                     " ORDER BY creation_date DESC ";
         } else {
             if ($a_user_id) {
                 $user_id = $a_user_id;
             } else {
                 $user_id = $ilUser->getId();
             }
             $query = "SELECT il_news_item.* " .
                 ", il_news_read.user_id as user_read " .
                 "FROM il_news_item LEFT JOIN il_news_read " .
                 "ON il_news_item.id = il_news_read.news_id AND " .
                 " il_news_read.user_id = " . $ilDB->quote($user_id, "integer") .
                 " WHERE " .
                     $ilDB->in("context_obj_id", $ids, false, "integer") . " " .
                     $and .
                     " ORDER BY creation_date DESC ";
         }
 
         $set = $ilDB->query($query);
         $result = [];
         while ($rec = $ilDB->fetchAssoc($set)) {
             if ($type[$rec["context_obj_id"]] == $rec["context_obj_type"]) {
                 if (!$a_for_rss_use || self::getPrivateFeedId() > 0 || ($rec["visibility"] === NEWS_PUBLIC ||
                     ((int) $rec["priority"] === 0 &&
                     ilBlockSetting::_lookup(
                         "news",
                         "public_notifications",
                         0,
                         (int) $rec["context_obj_id"]
                     )))) {
                     $result[$rec["id"]] = $rec;
                 }
             }
         }
 
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilNewsItem::read ( )

Read item from database.

Deprecated:: (will migrate to ilNewsData or other class taking care of persistence)

Definition at line 348 of file class.ilNewsItem.php.

References $db, $ilDB, getId(), setContent(), setContentHtml(), setContentIsLangVar(), setContentLong(), setContentTextIsLangVar(), setContentType(), setContextObjId(), setContextObjType(), setContextSubObjId(), setContextSubObjType(), setCreationDate(), setMobDownloadCounter(), setMobId(), setMobPlayCounter(), setPlaytime(), setPriority(), setTitle(), setUpdateDate(), setUpdateUserId(), setUserId(), and setVisibility().

Referenced by __construct().

                           : void
     {
         $ilDB = $this->db;
 
         $query = "SELECT * FROM il_news_item WHERE id = " .
             $ilDB->quote($this->getId(), "integer");
         $set = $ilDB->query($query);
         if ($rec = $ilDB->fetchAssoc($set)) {
             $this->setTitle((string) $rec["title"]);
             $this->setContent((string) $rec["content"]);
             $this->setContextObjId((int) $rec["context_obj_id"]);
             $this->setContextObjType($rec["context_obj_type"]);
             $this->setContextSubObjId((int) $rec["context_sub_obj_id"]);
             $this->setContextSubObjType((string) $rec["context_sub_obj_type"]);
             $this->setContentType((string) $rec["content_type"]);
             $this->setCreationDate((string) $rec["creation_date"]);
             $this->setUpdateDate((string) $rec["update_date"]);
             $this->setUserId((int) $rec["user_id"]);
             $this->setUpdateUserId((int) $rec["update_user_id"]);
             $this->setVisibility((string) $rec["visibility"]);
             $this->setContentLong((string) $rec["content_long"]);
             $this->setPriority((int) $rec["priority"]);
             $this->setContentIsLangVar((bool) $rec["content_is_lang_var"]);
             $this->setContentTextIsLangVar((bool) $rec["content_text_is_lang_var"]);
             $this->setMobId((int) $rec["mob_id"]);
             $this->setPlaytime((string) $rec["playtime"]);
             $this->setMobPlayCounter((int) $rec["mob_cnt_play"]);
             $this->setMobDownloadCounter((int) $rec["mob_cnt_download"]);
             $this->setContentHtml((bool) $rec["content_html"]);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setContent()

ilNewsItem::setContent ( string $a_content )

Definition at line 120 of file class.ilNewsItem.php.

Referenced by read().

                                                  : void
     {
         $this->content = $a_content;
     }

Here is the caller graph for this function:

◆ setContentHtml()

ilNewsItem::setContentHtml ( bool $a_val )

Definition at line 334 of file class.ilNewsItem.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setContentIsLangVar()

ilNewsItem::setContentIsLangVar ( bool $a_content_is_lang_var = false )

Definition at line 257 of file class.ilNewsItem.php.

Referenced by read().

      : void {
         $this->content_is_lang_var = $a_content_is_lang_var;
     }

Here is the caller graph for this function:

◆ setContentLong()

ilNewsItem::setContentLong ( string $a_content_long )

Parameters

string $a_content_long Long content of news

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

Referenced by read().

                                                           : void
     {
         $this->content_long = $a_content_long;
     }

Here is the caller graph for this function:

◆ setContentTextIsLangVar()

ilNewsItem::setContentTextIsLangVar ( bool $a_val = false )

Definition at line 304 of file class.ilNewsItem.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setContentType()

ilNewsItem::setContentType ( string $a_content_type = "text" )

Definition at line 170 of file class.ilNewsItem.php.

Referenced by read().

                                                                    : void
     {
         $this->content_type = $a_content_type;
     }

Here is the caller graph for this function:

◆ setContext()

ilNewsItem::setContext	(	int	$a_obj_id,
		string	$a_obj_type,
		int	$a_sub_obj_id = `0`,
		string	$a_sub_obj_type = `""`
	)

Set context for news.

Definition at line 1009 of file class.ilNewsItem.php.

References setContextObjId(), setContextObjType(), setContextSubObjId(), and setContextSubObjType().

      : void {
         $this->setContextObjId($a_obj_id);
         $this->setContextObjType($a_obj_type);
         $this->setContextSubObjId($a_sub_obj_id);
         $this->setContextSubObjType($a_sub_obj_type);
     }

Here is the call graph for this function:

◆ setContextObjId()

ilNewsItem::setContextObjId ( int $a_context_obj_id )

Definition at line 130 of file class.ilNewsItem.php.

Referenced by ilNewsItemGUI\getNewsForContextBlock(), ilNewsItemGUI\getNewsForContextTable(), read(), and setContext().

                                                           : void
     {
         $this->context_obj_id = $a_context_obj_id;
     }

Here is the caller graph for this function:

◆ setContextObjType()

ilNewsItem::setContextObjType ( string $a_context_obj_type )

Definition at line 140 of file class.ilNewsItem.php.

Referenced by ilNewsItemGUI\getNewsForContextBlock(), ilNewsItemGUI\getNewsForContextTable(), read(), and setContext().

                                                                  : void
     {
         $this->context_obj_type = $a_context_obj_type;
     }

Here is the caller graph for this function:

◆ setContextSubObjId()

ilNewsItem::setContextSubObjId ( int $a_context_sub_obj_id )

Definition at line 150 of file class.ilNewsItem.php.

Referenced by ilNewsItemGUI\getNewsForContextBlock(), ilNewsItemGUI\getNewsForContextTable(), read(), and setContext().

                                                                  : void
     {
         $this->context_sub_obj_id = $a_context_sub_obj_id;
     }

Here is the caller graph for this function:

◆ setContextSubObjType()

ilNewsItem::setContextSubObjType ( ?string $a_context_sub_obj_type )

Definition at line 160 of file class.ilNewsItem.php.

Referenced by ilNewsItemGUI\getNewsForContextBlock(), ilNewsItemGUI\getNewsForContextTable(), read(), and setContext().

                                                                          : void
     {
         $this->context_sub_obj_type = $a_context_sub_obj_type;
     }

Here is the caller graph for this function:

◆ setCreationDate()

ilNewsItem::setCreationDate ( string $a_creation_date )

Definition at line 180 of file class.ilNewsItem.php.

Referenced by read().

                                                             : void
     {
         $this->creation_date = $a_creation_date;
     }

Here is the caller graph for this function:

◆ setId()

ilNewsItem::setId ( int $a_id )

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

Referenced by __construct(), and create().

                                     : void
     {
         $this->id = $a_id;
     }

Here is the caller graph for this function:

◆ setLimitation()

ilNewsItem::setLimitation ( bool $a_limitation )

Set Limitation for number of items.

Definition at line 294 of file class.ilNewsItem.php.

                                                      : void
     {
         $this->limitation = $a_limitation;
     }

◆ setMobDownloadCounter()

ilNewsItem::setMobDownloadCounter ( int $a_val )

Definition at line 324 of file class.ilNewsItem.php.

Referenced by increaseDownloadCounter(), and read().

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

Here is the caller graph for this function:

◆ setMobId()

ilNewsItem::setMobId ( int $a_mob_id )

Definition at line 268 of file class.ilNewsItem.php.

Referenced by read().

                                            : void
     {
         $this->mob_id = $a_mob_id;
     }

Here is the caller graph for this function:

◆ setMobPlayCounter()

ilNewsItem::setMobPlayCounter ( int $a_val )

Definition at line 314 of file class.ilNewsItem.php.

Referenced by increasePlayCounter(), and read().

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

Here is the caller graph for this function:

◆ setPlaytime()

ilNewsItem::setPlaytime ( string $a_playtime )

Parameters

string $a_playtime Play Time, hh:mm:ss (of attached media file)

Definition at line 281 of file class.ilNewsItem.php.

Referenced by ilObjMediaCastGUI\determinePlaytimeObject(), and read().

                                                    : void
     {
         $this->playtime = $a_playtime;
     }

Here is the caller graph for this function:

◆ setPriority()

ilNewsItem::setPriority ( int $a_priority = 1 )

Definition at line 247 of file class.ilNewsItem.php.

Referenced by read().

                                                     : void
     {
         $this->priority = $a_priority;
     }

Here is the caller graph for this function:

◆ setPrivateFeedId()

static ilNewsItem::setPrivateFeedId ( int $a_userId )

static

Deprecated:: will move to settings->user

Definition at line 1895 of file class.ilNewsItem.php.

Referenced by ilObjectFeedWriter\__construct().

                                                           : void
     {
         self::$privFeedId = $a_userId;
     }

Here is the caller graph for this function:

◆ setTitle()

ilNewsItem::setTitle ( string $a_title )

Definition at line 110 of file class.ilNewsItem.php.

Referenced by read(), and ilNewsTimelineGUI\update().

                                              : void
     {
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ setUpdateDate()

ilNewsItem::setUpdateDate ( string $a_update_date )

Definition at line 190 of file class.ilNewsItem.php.

Referenced by read().

                                                         : void
     {
         $this->update_date = $a_update_date;
     }

Here is the caller graph for this function:

◆ setUpdateUserId()

ilNewsItem::setUpdateUserId ( int $a_val )

Definition at line 210 of file class.ilNewsItem.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setUserId()

ilNewsItem::setUserId ( int $a_user_id )

Definition at line 200 of file class.ilNewsItem.php.

Referenced by read().

                                              : void
     {
         $this->user_id = $a_user_id;
     }

Here is the caller graph for this function:

◆ setVisibility()

ilNewsItem::setVisibility ( string $a_visibility = "users" )

Parameters

string $a_visibility Access level of news.

Definition at line 223 of file class.ilNewsItem.php.

Referenced by read().

      : void {
         $this->visibility = $a_visibility;
     }

Here is the caller graph for this function:

◆ update()

ilNewsItem::update ( bool $a_as_new = false )

Update item in database.

Deprecated:: (will migrate to ilNewsData or other class taking care of persistence)

Parameters

bool $a_as_new If true, creation date is set "now"

Definition at line 461 of file class.ilNewsItem.php.

References $db, $ilDB, getContent(), getContentHtml(), getContentIsLangVar(), getContentLong(), getContentTextIsLangVar(), getContentType(), getContextObjId(), getContextObjType(), getContextSubObjId(), getContextSubObjType(), getId(), getMobDownloadCounter(), getMobId(), getMobPlayCounter(), getPlaytime(), getPriority(), getTitle(), getUpdateUserId(), getUserId(), getVisibility(), ILIAS\Repository\int(), and ilUtil\now().

Referenced by ILIAS\News\Items\NewsItemManager\save().

                                                   : void
     {
         $ilDB = $this->db;
 
         $fields = [
             "title" => ["text", $this->getTitle()],
             "content" => ["clob", $this->getContent()],
             "content_html" => ["integer", (int) $this->getContentHtml()],
             "context_obj_id" => ["integer", $this->getContextObjId()],
             "context_obj_type" => ["text", $this->getContextObjType()],
             "context_sub_obj_id" => ["integer", $this->getContextSubObjId()],
             "context_sub_obj_type" => ["text", $this->getContextSubObjType()],
             "content_type" => ["text", $this->getContentType()],
             "user_id" => ["integer", $this->getUserId()],
             "update_user_id" => ["integer", $this->getUpdateUserId()],
             "visibility" => ["text", $this->getVisibility()],
             "content_long" => ["clob", $this->getContentLong()],
             "priority" => ["integer", $this->getPriority()],
             "content_is_lang_var" => ["integer", $this->getContentIsLangVar()],
             "content_text_is_lang_var" => ["integer", (int) $this->getContentTextIsLangVar()],
             "mob_id" => ["integer", $this->getMobId()],
             "mob_cnt_play" => ["integer", $this->getMobPlayCounter()],
             "mob_cnt_download" => ["integer", $this->getMobDownloadCounter()],
             "playtime" => ["text", $this->getPlaytime()]
         ];
 
         $now = ilUtil::now();
         if ($a_as_new) {
             $fields["creation_date"] = ["timestamp", $now];
         }
         $fields["update_date"] = ["timestamp", $now];
 
         $ilDB->update("il_news_item", $fields, [
             "id" => ["integer", $this->getId()]
         ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilNewsItem::$access

protected

Definition at line 49 of file class.ilNewsItem.php.

Referenced by getAggregatedChildNewsData(), and getAggregatedNewsData().

◆ $content

string ilNewsItem::$content = ""

protected

Definition at line 56 of file class.ilNewsItem.php.

Referenced by getContent().

◆ $content_html

bool ilNewsItem::$content_html = false

protected

Definition at line 57 of file class.ilNewsItem.php.

Referenced by getContentHtml().

◆ $content_is_lang_var

bool ilNewsItem::$content_is_lang_var = false

protected

Definition at line 70 of file class.ilNewsItem.php.

Referenced by getContentIsLangVar().

◆ $content_long

string ilNewsItem::$content_long = ""

protected

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

Referenced by getContentLong().

◆ $content_text_is_lang_var

bool ilNewsItem::$content_text_is_lang_var = false

protected

Definition at line 75 of file class.ilNewsItem.php.

Referenced by getContentTextIsLangVar().

◆ $content_type

string ilNewsItem::$content_type = "text"

protected

Definition at line 62 of file class.ilNewsItem.php.

Referenced by getContentType().

◆ $context_obj_id

int ilNewsItem::$context_obj_id = 0

protected

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

Referenced by getContextObjId().

◆ $context_obj_type

string ilNewsItem::$context_obj_type = ""

protected

Definition at line 59 of file class.ilNewsItem.php.

Referenced by getContextObjType().

◆ $context_sub_obj_id

int ilNewsItem::$context_sub_obj_id = 0

protected

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

Referenced by getContextSubObjId().

◆ $context_sub_obj_type

string ilNewsItem::$context_sub_obj_type = null

protected

Definition at line 61 of file class.ilNewsItem.php.

Referenced by getContextSubObjType().

◆ $creation_date

string ilNewsItem::$creation_date = ""

protected

Definition at line 63 of file class.ilNewsItem.php.

Referenced by getCreationDate().

◆ $ctrl

ilCtrl ilNewsItem::$ctrl

protected

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

◆ $db

ilDBInterface ilNewsItem::$db

protected

Definition at line 47 of file class.ilNewsItem.php.

Referenced by checkNewsExistsForObjects(), create(), delete(), increaseDownloadCounter(), increasePlayCounter(), queryNewsForContext(), queryNewsForMultipleContexts(), read(), and update().

◆ $id

int ilNewsItem::$id = 0

protected

Definition at line 54 of file class.ilNewsItem.php.

Referenced by getId(), getLastNewsIdForContext(), and mergeNews().

◆ $limitation

bool ilNewsItem::$limitation = false

private

Definition at line 74 of file class.ilNewsItem.php.

Referenced by getLimitation().

◆ $lng

ilLanguage ilNewsItem::$lng

protected

Definition at line 52 of file class.ilNewsItem.php.

◆ $log

ilLogger ilNewsItem::$log

protected

Definition at line 77 of file class.ilNewsItem.php.

◆ $main_tpl

ilGlobalTemplateInterface ilNewsItem::$main_tpl

private

Definition at line 76 of file class.ilNewsItem.php.

◆ $media_manager

MediaObjectManager ilNewsItem::$media_manager

protected

Definition at line 45 of file class.ilNewsItem.php.

◆ $mob_cnt_download

int ilNewsItem::$mob_cnt_download = 0

private

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

Referenced by getMobDownloadCounter().

◆ $mob_cnt_play

int ilNewsItem::$mob_cnt_play = 0

protected

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

Referenced by getMobPlayCounter().

◆ $mob_id

int ilNewsItem::$mob_id = 0

protected

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

Referenced by getMobId().

◆ $obj_data_cache

ilObjectDataCache ilNewsItem::$obj_data_cache

protected

Definition at line 50 of file class.ilNewsItem.php.

Referenced by getAggregatedNewsData().

◆ $playtime

string ilNewsItem::$playtime = ""

protected

Definition at line 72 of file class.ilNewsItem.php.

Referenced by getPlaytime().

◆ $priority

int ilNewsItem::$priority = 1

protected

Definition at line 69 of file class.ilNewsItem.php.

Referenced by getPriority().

◆ $privFeedId

int ilNewsItem::$privFeedId = 0

staticprivate

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

◆ $title

string ilNewsItem::$title = ""

protected

Definition at line 55 of file class.ilNewsItem.php.

Referenced by getTitle().

◆ $tree

ilTree ilNewsItem::$tree

protected

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

Referenced by getAggregatedChildNewsData(), and getAggregatedNewsData().

◆ $update_date

string ilNewsItem::$update_date = ""

protected

Definition at line 64 of file class.ilNewsItem.php.

Referenced by getUpdateDate().

◆ $update_user_id

int ilNewsItem::$update_user_id = 0

protected

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

Referenced by getUpdateUserId().

◆ $user

ilObjUser ilNewsItem::$user

protected

Definition at line 51 of file class.ilNewsItem.php.

Referenced by queryNewsForContext(), and queryNewsForMultipleContexts().

◆ $user_id

int ilNewsItem::$user_id = 0

protected

Definition at line 65 of file class.ilNewsItem.php.

Referenced by getUserId().

◆ $visibility

string ilNewsItem::$visibility = "users"

protected

Definition at line 67 of file class.ilNewsItem.php.

Referenced by _getDefaultVisibilityForRefId(), and getVisibility().

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

components/ILIAS/News/classes/class.ilNewsItem.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getDefaultVisibilityForRefId()

◆ _getNewsItemsOfUser()

◆ _lookupContextObjId()

◆ _lookupDefaultPDPeriod()

◆ _lookupMediaObjectUsages()

◆ _lookupMobId()

◆ _lookupRSSPeriod()

◆ _lookupTitle()

◆ _lookupUserPDPeriod()

◆ _lookupVisibility()

◆ _setRead()

◆ _setUnread()

◆ aggregateFiles()

◆ aggregateForums()

◆ checkNewsExistsForObjects()

◆ create()

◆ delete()

◆ deleteNewsOfContext()

◆ deliverMobFile()

◆ determineNewsContent()

◆ determineNewsTitle()

◆ determineNewsTitleByNewsId()

◆ filterObjIdsPerNews()

◆ getAggregatedChildNewsData()

◆ getAggregatedNewsData()

◆ getContent()

◆ getContentHtml()

◆ getContentIsLangVar()

◆ getContentLong()

◆ getContentTextIsLangVar()

◆ getContentType()

◆ getContextObjId()

◆ getContextObjType()

◆ getContextSubObjId()

◆ getContextSubObjType()

◆ getCreationDate()

◆ getFirstNewsIdForContext()

◆ getId()

◆ getLastNewsIdForContext()

◆ getLimitation()

◆ getMobDownloadCounter()

◆ getMobId()

◆ getMobPlayCounter()

◆ getNewsForRefId()

◆ getNewsOfContext()

◆ getPlaytime()

◆ getPriority()

◆ getPrivateFeedId()

◆ getTitle()

◆ getUpdateDate()

◆ getUpdateUserId()

◆ getUserId()

◆ getVisibility()

◆ handleTimePeriod()

◆ increaseDownloadCounter()

◆ increasePlayCounter()

◆ mergeNews()

◆ prepareNewsDataFromCache()

◆ queryNewsByIds()

◆ queryNewsForContext()

◆ queryNewsForMultipleContexts()

◆ read()

◆ setContent()

◆ setContentHtml()

◆ setContentIsLangVar()

◆ setContentLong()

◆ setContentTextIsLangVar()

◆ setContentType()

◆ setContext()