ilNewsItem Class Reference

Collaboration diagram for ilNewsItem:

Public Member Functions
	__construct ($a_id=0)
	Constructor. More...
	setId ($a_id)
	Set Id. More...
	getId ()
	Get Id. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setContent ($a_content)
	Set Content. More...
	getContent ()
	Get Content. More...
	setContextObjId ($a_context_obj_id)
	Set ContextObjId. More...
	getContextObjId ()
	Get ContextObjId. More...
	setContextObjType ($a_context_obj_type)
	Set ContextObjType. More...
	getContextObjType ()
	Get ContextObjType. More...
	setContextSubObjId ($a_context_sub_obj_id)
	Set ContextSubObjId. More...
	getContextSubObjId ()
	Get ContextSubObjId. More...
	setContextSubObjType ($a_context_sub_obj_type)
	Set ContextSubObjType. More...
	getContextSubObjType ()
	Get ContextSubObjType. More...
	setContentType ($a_content_type="text")
	Set ContentType. More...
	getContentType ()
	Get ContentType. More...
	setCreationDate ($a_creation_date)
	Set CreationDate. More...
	getCreationDate ()
	Get CreationDate. More...
	setUpdateDate ($a_update_date)
	Set UpdateDate. More...
	getUpdateDate ()
	Get UpdateDate. More...
	setUserId ($a_user_id)
	Set UserId. More...
	getUserId ()
	Get UserId. More...
	setUpdateUserId ($a_val)
	Set update user id. More...
	getUpdateUserId ()
	Get update user id. More...
	setVisibility ($a_visibility="users")
	Set Visibility. More...
	getVisibility ()
	Get Visibility. More...
	setContentLong ($a_content_long)
	Set ContentLong. More...
	getContentLong ()
	Get ContentLong. More...
	setPriority ($a_priority=1)
	Set Priority. More...
	getPriority ()
	Get Priority. More...
	setContentIsLangVar ($a_content_is_lang_var=0)
	Set ContentIsLangVar. More...
	getContentIsLangVar ()
	Get ContentIsLangVar. More...
	setMobId ($a_mob_id)
	Set MobId. More...
	getMobId ()
	Get MobId. More...
	setPlaytime ($a_playtime)
	Set Playtime. More...
	getPlaytime ()
	Get Playtime. More...
	setLimitation ($a_limitation)
	Set Limitation for number of items. More...
	getLimitation ()
	Get Limitation for number of items. More...
	setContentTextIsLangVar ($a_val=0)
	Set content text ist lang var. More...
	getContentTextIsLangVar ()
	Get content text ist lang var. More...
	setMobPlayCounter ($a_val)
	Set mob play counter. More...
	getMobPlayCounter ()
	Get mob play counter. More...
	setMobDownloadCounter ($a_val)
	Set mob download counter. More...
	getMobDownloadCounter ()
	Get mob download counter. More...
	setContentHtml ($a_val)
	Is content HTML (tiny used?) More...
	getContentHtml ()
	Get content as html. More...
	read ()
	Read item from database. More...
	create ()
	Create. More...
	update ($a_as_new=false)
	Update item in database. More...
	getNewsForRefId ($a_ref_id, $a_only_public=false, $a_stopnesting=false, $a_time_period=0, $a_prevent_aggregation=true, $a_forum_group_sequences=false, $a_no_auto_generated=false, $a_ignore_date_filter=false, $a_user_id=null, $a_limit=0, $a_excluded=array())
	Get News For Ref Id. More...
	getAggregatedNewsData ($a_ref_id, $a_only_public=false, $a_time_period=0, $a_prevent_aggregation=false, $a_starting_date="", $a_no_auto_generated=false, $a_user_id=null, $a_limit=0, $a_exclude=array())
	Get news aggregation (e.g. More...
	aggregateForums ($news, $a_group_posting_sequence=false)
	aggregateFiles ($news, $a_ref_id)
	getAggregatedChildNewsData ($a_ref_id, $a_only_public=false, $a_time_period=0, $a_prevent_aggregation=false, $a_starting_date="", $a_no_auto_generated=false)
	Get news aggregation for child objects (e.g. More...
	setContext ($a_obj_id, $a_obj_type, $a_sub_obj_id=0, $a_sub_obj_type="")
	Convenient function to set the whole context information. More...
	queryNewsForContext ($a_for_rss_use=false, $a_time_period=0, $a_starting_date="", $a_no_auto_generated=false, $a_oldest_first=false, $a_limit=0)
	Query news for a context. More...
	checkNewsExistsForGroupCourse ($a_ref_id, $a_time_period=1)
	queryNewsForMultipleContexts ($a_contexts, $a_for_rss_use=false, $a_time_period=0, $a_starting_date="", $a_no_auto_generated=false, $a_user_id=null, $a_limit=0, $a_exclude=array())
	Query News for multiple Contexts. More...
	delete ()
	Delete news item. More...
	deliverMobFile ($a_purpose="Standard", $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 ($a_user_id, $a_only_public=false, $a_prevent_aggregation=false, $a_per=0, &$a_cnt=NULL)
	Get all news items for a user. More...
static	_setRead ($a_user_id, $a_news_id)
	Set item read. More...
static	_setUnread ($a_user_id, $a_news_id)
	Set item unread. More...
static	mergeNews ($n1, $n2)
	Merges two sets of news. More...
static	_getDefaultVisibilityForRefId ($a_ref_id)
	Get default visibility for reference id. More...
static	deleteNewsOfContext ($a_context_obj_id, $a_context_obj_type, $a_context_sub_obj_id=0, $a_context_sub_obj_type="")
	Delete all news of a context. More...
static	_lookupTitle ($a_news_id)
	Lookup News Title. More...
static	_lookupVisibility ($a_news_id)
	Lookup News Visibility. More...
static	_lookupMobId ($a_news_id)
	Lookup mob id. More...
static	filterObjIdsPerNews ($a_obj_ids, $a_time_period=0, $a_starting_date="", $a_ending_date='', $ignore_period=false)
	Checks whether news are available for. More...
static	determineNewsTitle ($a_context_obj_type, $a_title, $a_content_is_lang_var, $a_agg_ref_id=0, $a_aggregation="")
	Determine title for news item entry. More...
static	determineNewsContent ($a_context_obj_type, $a_content, $a_is_lang_var)
	Determine new content. More...
static	getFirstNewsIdForContext ($a_context_obj_id, $a_context_obj_type, $a_context_sub_obj_id="", $a_context_sub_obj_type="")
	Get first new id of news set related to a certain context. More...
static	getLastNewsIdForContext ($a_context_obj_id, $a_context_obj_type, $a_context_sub_obj_id="", $a_context_sub_obj_type="", $a_only_today=false)
	Get last news id of news set related to a certain context. More...
static	_lookupMediaObjectUsages ($a_mob_id)
	Lookup media object usage(s) More...
static	_lookupContextObjId ($a_news_id)
	Context Object ID. More...
static	_lookupDefaultPDPeriod ()
static	_lookupUserPDPeriod ($a_user_id)
static	_lookupRSSPeriod ()
static	setPrivateFeedId ($a_userId)
static	getPrivateFeedId ()
static	prepareNewsDataFromCache ($a_cres)
	Prepare news data from cache. More...

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

Protected Attributes
	$id
	$title
	$content
	$content_html
	$context_obj_id
	$context_obj_type
	$context_sub_obj_id
	$context_sub_obj_type
	$content_type = "text"
	$creation_date
	$update_date
	$user_id
	$update_user_id
	$visibility = "users"
	$content_long
	$priority = 1
	$content_is_lang_var = 0
	$mob_id
	$playtime

Private Attributes
	$limitation

Static Private Attributes
static	$privFeedId = false

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilNewsItem::__construct

(

$a_id = 0

)

Constructor.

Parameters

int

$a_id

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

References read(), and setId().

        {
                if ($a_id > 0)
                {
                        $this->setId($a_id);
                        $this->read();
                }
                $this->limitation = true;
        }

Here is the call graph for this function:

Member Function Documentation

_getDefaultVisibilityForRefId()

static ilNewsItem::_getDefaultVisibilityForRefId (   $a_ref_id )

static

Get default visibility for reference id.

Parameters

$a_ref_id

reference id

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

References $ilSetting, $path, $row, $visibility, ilBlockSetting\_lookup(), and array.

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

        {
                global $tree, $ilSetting;

                include_once("./Services/Block/classes/class.ilBlockSetting.php");

                $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"], array("root", "cat","crs", "fold", "grp")))
                                {
                                        continue;
                                }

                                $visibility = ilBlockSetting::_lookup("news", "default_visibility",
                                        0, $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 (   $a_user_id,   $a_only_public = false,   $a_prevent_aggregation = false,   $a_per = 0, &  $a_cnt = NULL  )

static

Get all news items for a user.

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

References $data, $ref_id, ilObject\_getAllReferences(), ilParticipants\_getMembershipByType(), ilNewsSubscription\_getSubscriptionsOfUser(), ilObjUser\_lookupDesktopItems(), ilObject\_lookupObjId(), ilObjUser\_lookupPref(), ilObject\_lookupType(), array, getPrivateFeedId(), mergeNews(), and ilUtil\sortArray().

Referenced by ilUserFeedWriter\__construct(), and ilPDNewsBlockGUI\getNewsData().

        {
                global $ilAccess;

                $news_item = new ilNewsItem();
                $news_set = new ilSetting("news");
                
                $per = $a_per;

                include_once("./Services/News/classes/class.ilNewsSubscription.php");
                include_once("./Services/Block/classes/class.ilBlockSetting.php");
                
                // this is currently not used
                $ref_ids = ilNewsSubscription::_getSubscriptionsOfUser($a_user_id);
                
                if (ilObjUser::_lookupPref($a_user_id, "pd_items_news") != "n")
                {
                        // get all items of the personal desktop
                        $pd_items = ilObjUser::_lookupDesktopItems($a_user_id);
                        foreach($pd_items as $item)
                        {
                                if (!in_array($item["ref_id"], $ref_ids))
                                {
                                        $ref_ids[] = $item["ref_id"];
                                }
                        }
                        
                        // get all memberships
                        include_once 'Services/Membership/classes/class.ilParticipants.php';
                        $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 = array();

                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 (ilNewsItem::getPrivateFeedId() != false) {
                                global $rbacsystem;
                                $acc = $rbacsystem->checkAccessOfUser(ilNewsItem::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, false, false, $a_user_id);
                        
                        // counter
                        if (!is_null($a_cnt))
                        {
                                $a_cnt[$ref_id] = count($news);
                        }

                        $data = ilNewsItem::mergeNews($data, $news);
                }

        $data = ilUtil::sortArray($data, "creation_date", "desc", false, true);

                return $data;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupContextObjId()

static ilNewsItem::_lookupContextObjId (   $a_news_id )

static

Context Object ID.

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

References $ilDB, and $query.

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

        {
                global $ilDB;
                
                $query = "SELECT * ".
                        "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

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

Referenced by _lookupUserPDPeriod(), ilObjNewsSettingsGUI\editSettings(), ilPDNewsBlockGUI\editSettings(), and ilPDNewsTableGUI\initFilter().

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

Here is the caller graph for this function:

_lookupMediaObjectUsages()

static ilNewsItem::_lookupMediaObjectUsages (   $a_mob_id )

static

Lookup media object usage(s)

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

References $ilDB, $query, and array.

Referenced by ilObjMediaObject\lookupUsages().

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

Here is the caller graph for this function:

_lookupMobId()

static ilNewsItem::_lookupMobId (   $a_news_id )

static

Lookup mob id.

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

References $ilDB, and $query.

Referenced by ilNewsExporter\getXmlExportHeadDependencies().

        {
                global $ilDB;

                $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 $rec["mob_id"];
        }

Here is the caller graph for this function:

_lookupRSSPeriod()

static ilNewsItem::_lookupRSSPeriod ( )

static

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

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), ilObjNewsSettingsGUI\editSettings(), and ilObjMediaCastGUI\initSettingsForm().

        {
                $news_set = new ilSetting("news");
                $rss_period = $news_set->get("rss_period");
                if ($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 (   $a_news_id )

static

Lookup News Title.

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

References $ilDB, and $query.

        {
                global $ilDB;
                
                $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 (   $a_user_id )

static

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

References ilBlockSetting\_lookup(), and _lookupDefaultPDPeriod().

Referenced by ilPDNewsBlockGUI\editSettings(), ilPDNewsBlockGUI\getHTML(), ilPDNewsBlockGUI\getNewsData(), ilPDNewsTableGUI\initFilter(), and ilPDNewsGUI\view().

        {
                $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 = ilNewsItem::_lookupDefaultPDPeriod();
                
                include_once("./Services/Block/classes/class.ilBlockSetting.php");
                $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 $per;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupVisibility()

static ilNewsItem::_lookupVisibility (   $a_news_id )

static

Lookup News Visibility.

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

References $ilDB, and $query.

Referenced by ilObjMediaObjectAccess\checkAccessMob().

        {
                global $ilDB;
                
                $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"];
        }

Here is the caller graph for this function:

_setRead()

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

static

Set item read.

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

References $ilDB, and array.

Referenced by ilNewsForContextBlockGUI\showNews().

        {
                global $ilDB, $ilAppEventHandler;
                
                $ilDB->replace("il_news_read",
                        array(
                                "user_id" => array("integer", $a_user_id),
                                "news_id" => array("integer", $a_news_id)
                                ),
                        array()
                        );
                
                /*
                $ilDB->manipulate("DELETE FROM il_news_read WHERE ".
                        "user_id = ".$ilDB->quote($a_user_id, "integer").
                        " AND news_id = ".$ilDB->quote($a_news_id, "integer"));
                $ilDB->manipulate("INSERT INTO il_news_read (user_id, news_id) VALUES (".
                        $ilDB->quote($a_user_id, "integer").",".
                        $ilDB->quote($a_news_id, "integer").")");*/

                $ilAppEventHandler->raise("Services/News", "readNews",
                        array("user_id" => $a_user_id, "news_ids" => array($a_news_id)));
        }

Here is the caller graph for this function:

_setUnread()

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

static

Set item unread.

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

References $ilDB, and array.

        {
                global $ilDB, $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("Services/News", "unreadNews",
                        array("user_id" => $a_user_id, "news_ids" => array($a_news_id)));
        }

aggregateFiles()

ilNewsItem::aggregateFiles	(		$news,
			$a_ref_id
	)

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

References array.

Referenced by getAggregatedChildNewsData(), and getAggregatedNewsData().

        {
                $first_file = "";
                $to_del = array();
                foreach ($news as $k => $v)
                {
                        // aggregate file related news
                        if ($news[$k]["context_obj_type"] == "file")
                        {
                                if ($first_file == "")
                                {
                                        $first_file = $k;
                                }
                                else
                                {
                                        $to_del[] = $k;
                                }
                                $news[$first_file]["aggregation"][$k] = $news[$k];
                                $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	(		$news,
			$a_group_posting_sequence = false
	)

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

References array.

Referenced by getNewsForRefId().

        {
                $to_del = array();
                $forums = array();
                
                // aggregate
                foreach ($news as $k => $v)
                {
                        if ($a_group_posting_sequence && $last_aggregation_forum > 0 &&
                                $last_aggregation_forum != $news[$k]["context_obj_id"])
                        {
                                $forums[$last_aggregation_forum] = "";
                        }

                        if ($news[$k]["context_obj_type"] == "frm")
                        {
                                if ($forums[$news[$k]["context_obj_id"]] == "")
                                {
                                        // $forums[forum_id] = news_id;
                                        $forums[$news[$k]["context_obj_id"]] = $k;
                                        $last_aggregation_forum = $news[$k]["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:

checkNewsExistsForGroupCourse()

ilNewsItem::checkNewsExistsForGroupCourse	(		$a_ref_id,
			$a_time_period = 1
	)

Parameters

int	$a_ref_id
int	$a_time_period	hours

Returns

array news item ids

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

References $ilDB, $query, and array.

        {
                global $tree, $ilDB;
                
                $all = array();

                if(!$tree->isDeleted($a_ref_id))
                {
                        // parse repository branch of group
                        $nodes = array();
                        $node = $tree->getNodeData($a_ref_id);                                  
                        foreach($tree->getSubTree($node) as $child)
                        {
                                if($child["type"] != "rolf")
                                {
                                        $nodes[$child["obj_id"]] = $child["type"];
                                }
                        }

                        $limit_ts = self::handleTimePeriod($a_time_period);

                        // are there any news items for relevant objects and?
                        $query = $ilDB->query("SELECT id,context_obj_id,context_obj_type".
                                " FROM il_news_item".
                                " WHERE ".$ilDB->in("context_obj_id", array_keys($nodes), false, "integer").
                                " AND creation_date >= ".$ilDB->quote($limit_ts, "timestamp"));
                        while($rec = $ilDB->fetchAssoc($query))
                        {
                                if ($nodes[$rec["context_obj_id"]] == $rec["context_obj_type"])
                                {
                                        $all[] = $rec["id"];
                                }
                        }               
                }
                
                return $all;            
        }

create()

ilNewsItem::create

(

)

Create.

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

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

        {
                global $ilDB;

                // insert new record into db
                $this->setId($ilDB->nextId("il_news_item"));
                $ilDB->insert("il_news_item", array(
                        "id" => array("integer", $this->getId()),
                        "title" => array("text", $this->getTitle()),
                        "content" => array("clob", $this->getContent()),
                        "content_html" => array("integer", (int) $this->getContentHtml()),
                        "context_obj_id" => array("integer", (int) $this->getContextObjId()),
                        "context_obj_type" => array("text", $this->getContextObjType()),
                        "context_sub_obj_id" => array("integer", (int) $this->getContextSubObjId()),
                        "context_sub_obj_type" => array("text", $this->getContextSubObjType()),
                        "content_type" => array("text", $this->getContentType()),
                        "creation_date" => array("timestamp", ilUtil::now()),
                        "update_date" => array("timestamp", ilUtil::now()),
                        "user_id" => array("integer", $this->getUserId()),
                        "update_user_id" => array("integer", (int) $this->getUpdateUserId()),
                        "visibility" => array("text", $this->getVisibility()),
                        "content_long" => array("clob", $this->getContentLong()),
                        "priority" => array("integer", $this->getPriority()),
                        "content_is_lang_var" => array("integer", $this->getContentIsLangVar()),
                        "content_text_is_lang_var" => array("integer", (int) $this->getContentTextIsLangVar()),
                        "mob_id" => array("integer", $this->getMobId()),
            "playtime" => array("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);
                                $del_set = $ilDB->query($query);
                                while ($del_item = $ilDB->fetchAssoc($del_set))
                                {
                                        $del_news = new ilNewsItem($del_item["id"]);
                                        $del_news->delete();
                                }
                        }
                }
        }

Here is the call graph for this function:

delete()

ilNewsItem::delete

(

)

Delete news item.

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

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

        {
                global $ilDB;
                
                // 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 and ilObject::_exists($mob))
                {
                        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                        $mob = new ilObjMediaObject($mob);
                        $mob->delete();
                }
        }

Here is the call graph for this function:

deleteNewsOfContext()

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

static

Delete all news of a context.

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

References $ilDB, and $query.

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

        {
                global $ilDB;
                
                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 * 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);
                
                while ($news = $ilDB->fetchAssoc($news_set))
                {
                        $news_obj = new ilNewsItem($news["id"]);
                        $news_obj->delete();
                }
        }

Here is the caller graph for this function:

deliverMobFile()

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

Deliver mob file.

Parameters

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

References $file, ilObjMediaObject\_getDirectory(), ilUtil\deliverFile(), getMobId(), increaseDownloadCounter(), ilUtil\redirect(), and ilUtil\sendFailure().

        {
                $mob = $this->getMobId();
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                $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")
                {
                    $file = $mob_dir."/".$m_item->getLocation();
                    if (file_exists($file) && is_file($file))
                    {
                        if ($a_increase_download_cnt)
                        {
                                $this->increaseDownloadCounter();
                        }
                        ilUtil::deliverFile($file, $m_item->getLocation(), "", false, false, false);
                                return true;
                    }
                    else
                    {
                        ilUtil::sendFailure("File not found!",true);
                        return false;
                    }
                }
                else 
                {
                        if ($a_increase_download_cnt)
                        {
                                $this->increaseDownloadCounter();
                        }
                    ilUtil::redirect($m_item->getLocation());
                }
        }

Here is the call graph for this function:

determineNewsContent()

static ilNewsItem::determineNewsContent (   $a_context_obj_type,   $a_content,   $a_is_lang_var  )

static

Determine new content.

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

References $a_content, and $lng.

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), ilPDNewsTableGUI\fillRow(), and ilMembershipCronNotifications\parseNewsItem().

        {
                global $lng;

                if ($a_is_lang_var)
                {
                        $lng->loadLanguageModule($a_context_obj_type);
                        return $lng->txt($a_content);
                }
                else
                {
                        return $a_content;
                }
        }

Here is the caller graph for this function:

determineNewsTitle()

static ilNewsItem::determineNewsTitle (   $a_context_obj_type,   $a_title,   $a_content_is_lang_var,   $a_agg_ref_id = 0,   $a_aggregation = ""  )

static

Determine title for news item entry.

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

References $lng.

Referenced by ilObjectFeedWriter\__construct(), ilUserFeedWriter\__construct(), ilNewsForContextBlockGUI\fillRow(), ilMembershipCronNotifications\parseNewsItem(), and ilNewsForContextBlockGUI\showNews().

        {
                global $lng;

                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);
                                }
                                else
                                {
                                        return $lng->txt("news_1_postings");
                                }
                        }
                        else    // 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 />";
                                }
                                else if ($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");
                                }
                                else if ($up_cnt > 1)
                                {
                                        $tit .= $sep.sprintf($lng->txt("news_x_files_updated"), $up_cnt);
                                }
                                return $tit;
                        }
                }
                else
                {
                        if ($a_content_is_lang_var)
                        {
                                return $lng->txt($a_title);
                        }
                        else
                        {
                                return $a_title;
                        }
                }
                
                return "";
        }

Here is the caller graph for this function:

filterObjIdsPerNews()

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

static

Checks whether news are available for.

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

References $ilDB, $query, and array.

Referenced by getAggregatedChildNewsData(), getAggregatedNewsData(), and ilPDNewsGUI\view().

        {
                global $ilDB;

                $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 = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $objs[] = $rec["obj_id"];
                }

                return $objs;
        }

Here is the caller graph for this function:

getAggregatedChildNewsData()

ilNewsItem::getAggregatedChildNewsData	(		$a_ref_id,
			$a_only_public = false,
			$a_time_period = 0,
			$a_prevent_aggregation = false,
			$a_starting_date = "",
			$a_no_auto_generated = false
	)

Get news aggregation for child objects (e.g.

for categories)

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

References $data, $ref_id, aggregateFiles(), array, filterObjIdsPerNews(), getNewsForRefId(), mergeNews(), queryNewsForMultipleContexts(), and ilUtil\sortArray().

Referenced by getNewsForRefId().

        {
                global $tree, $ilAccess;
                
                // get news of parent object
                $data = $this->getNewsForRefId($a_ref_id, $a_only_public, true, $a_time_period,
                        true, false, false, $a_no_auto_generated);
                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 = array();
                foreach($nodes as $node)
                {
                        $obj_ids[] = $node["obj_id"];
                }
        $news_obj_ids = ilNewsItem::filterObjIdsPerNews($obj_ids, $a_time_period, $a_starting_date);
                //$news_obj_ids = $obj_ids;

                // get news for all subtree nodes
                $contexts = array();
                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", "", $node["child"]))
                        {
                                continue;
                        }
                        $ref_id[$node["obj_id"]] = $node["child"];
                        $contexts[] = array("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);
                foreach ($news as $k => $v)
                {
                        $news[$k]["ref_id"] = $ref_id[$v["context_obj_id"]];
                }
                $data = ilNewsItem::mergeNews($data, $news);
                
                // sort and return
        $data = ilUtil::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	(		$a_ref_id,
			$a_only_public = false,
			$a_time_period = 0,
			$a_prevent_aggregation = false,
			$a_starting_date = "",
			$a_no_auto_generated = false,
			$a_user_id = null,
			$a_limit = 0,
			$a_exclude = array()
	)

Get news aggregation (e.g.

for courses, groups)

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

References $data, $ref_id, aggregateFiles(), array, filterObjIdsPerNews(), mergeNews(), ilObjectActivation\preloadData(), queryNewsForMultipleContexts(), and ilUtil\sortArray().

Referenced by getNewsForRefId().

        {
                global $tree, $ilAccess, $ilObjDataCache;
                
                // get news of parent object
                
                $data = array();
                
                // get subtree
                $cur_node = $tree->getNodeData($a_ref_id);

                // do not check for lft (materialized path)
                if($cur_node)
                {
                        $nodes = (array) $tree->getSubTree($cur_node,true);
                }
                else
                {
                        $nodes = array();
                }
                
                // preload object data cache
                $ref_ids = array();
                $obj_ids = array();
                foreach($nodes as $node)
                {
                        $ref_ids[] = $node["child"];
                        $obj_ids[] = $node["obj_id"];
                }

                $ilObjDataCache->preloadReferenceCache($ref_ids);
                if (!$a_only_public)
                {
                        include_once "Services/Object/classes/class.ilObjectActivation.php";
                        ilObjectActivation::preloadData($ref_ids);
                }
                
                // no check, for which of the objects any news are available
        $news_obj_ids = ilNewsItem::filterObjIdsPerNews($obj_ids, $a_time_period, $a_starting_date);
                //$news_obj_ids = $obj_ids;
                
                // get news for all subtree nodes
                $contexts = array();
                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", "", $node["child"]);
                                }
                                else
                                {
                                        $acc = $ilAccess->checkAccessOfUser($a_user_id, "read", "",
                                                $node["child"]);
                                }                               
                                if (!$acc)
                                {
                                        continue;
                                }
                        }
                        
                        $ref_id[$node["obj_id"]] = $node["child"];
                        $contexts[] = array("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 = array();
                foreach ($news as $k => $v)
                {
                        $news[$k]["ref_id"] = $ref_id[$v["context_obj_id"]];
                }
                
                $data = ilNewsItem::mergeNews($data, $news);
        $data = ilUtil::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

(

)

Get Content.

Returns

string Content of news.

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

References $content.

Referenced by create(), and update().

        {
                return $this->content;
        }

Here is the caller graph for this function:

getContentHtml()

ilNewsItem::getContentHtml

(

)

Get content as html.

Returns

bool

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

References $content_html.

Referenced by create(), and update().

        {
                return $this->content_html;
        }

Here is the caller graph for this function:

getContentIsLangVar()

ilNewsItem::getContentIsLangVar

(

)

Get ContentIsLangVar.

Returns

boolean

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

References $content_is_lang_var.

Referenced by create(), and update().

        {
                return $this->content_is_lang_var;
        }

Here is the caller graph for this function:

getContentLong()

ilNewsItem::getContentLong

(

)

Get ContentLong.

Returns

string Long content of news

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

References $content_long.

Referenced by create(), and update().

        {
                return $this->content_long;
        }

Here is the caller graph for this function:

getContentTextIsLangVar()

ilNewsItem::getContentTextIsLangVar

(

)

Get content text ist lang var.

Returns

boolean

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

Referenced by create(), and update().

        {
                return $this->content_text_is_lang_var;
        }

Here is the caller graph for this function:

getContentType()

ilNewsItem::getContentType

(

)

Get ContentType.

Returns

string Content type.

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

References $content_type.

Referenced by create(), and update().

        {
                return $this->content_type;
        }

Here is the caller graph for this function:

getContextObjId()

ilNewsItem::getContextObjId

(

)

Get ContextObjId.

Returns

int

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

References $context_obj_id.

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

        {
                return $this->context_obj_id;
        }

Here is the caller graph for this function:

getContextObjType()

ilNewsItem::getContextObjType

(

)

Get ContextObjType.

Returns

int

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

References $context_obj_type.

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

        {
                return $this->context_obj_type;
        }

Here is the caller graph for this function:

getContextSubObjId()

ilNewsItem::getContextSubObjId

(

)

Get ContextSubObjId.

Returns

int

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

References $context_sub_obj_id.

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

        {
                return $this->context_sub_obj_id;
        }

Here is the caller graph for this function:

getContextSubObjType()

ilNewsItem::getContextSubObjType

(

)

Get ContextSubObjType.

Returns

int

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

References $context_sub_obj_type.

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

        {
                return $this->context_sub_obj_type;
        }

Here is the caller graph for this function:

getCreationDate()

ilNewsItem::getCreationDate

(

)

Get CreationDate.

Returns

string Date of creation.

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

References $creation_date.

        {
                return $this->creation_date;
        }

getFirstNewsIdForContext()

static ilNewsItem::getFirstNewsIdForContext (   $a_context_obj_id,   $a_context_obj_type,   $a_context_sub_obj_id = "",   $a_context_sub_obj_type = ""  )

static

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

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

References $ilDB, and $query.

Referenced by ilForum\deletePost(), ilForumTopic\movePosts(), ilForum\postCensorship(), ilObjForumGUI\publishDraftObject(), and ilObjTest\saveToDb().

        {
                global $ilDB;
                
                // Determine how many rows should be deleted
                $query = "SELECT * ".
                        "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 $rec["id"];
        }

Here is the caller graph for this function:

getId()

ilNewsItem::getId

(

)

Get Id.

Returns

int

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

References $id.

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

        {
                return $this->id;
        }

Here is the caller graph for this function:

getLastNewsIdForContext()

static ilNewsItem::getLastNewsIdForContext (   $a_context_obj_id,   $a_context_obj_type,   $a_context_sub_obj_id = "",   $a_context_sub_obj_type = "",   $a_only_today = false  )

static

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

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

References $id, $ilDB, $query, and ilUtil\now().

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

        {
                global $ilDB;

                // 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);
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);

                $id = (int) $rec["id"];
                if ($a_only_today)
                {
                        $now = ilUtil::now();
                        if (substr($now, 0, 10) != substr($rec["update_date"], 0, 10))
                        {
                                $id = 0;
                        }
                }

                return $id;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getLimitation()

ilNewsItem::getLimitation

(

)

Get Limitation for number of items.

Returns

boolean Limitation for number of items

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

References $limitation.

Referenced by create().

        {
                return $this->limitation;
        }

Here is the caller graph for this function:

getMobDownloadCounter()

ilNewsItem::getMobDownloadCounter

(

)

Get mob download counter.

Returns

int counter

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

Referenced by increaseDownloadCounter(), and update().

        {
                return $this->mob_cnt_download;
        }

Here is the caller graph for this function:

getMobId()

ilNewsItem::getMobId

(

)

Get MobId.

Returns

int Media Object ID (if news includes attachement)

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

References $mob_id.

Referenced by create(), delete(), deliverMobFile(), and update().

        {
                return $this->mob_id;
        }

Here is the caller graph for this function:

getMobPlayCounter()

ilNewsItem::getMobPlayCounter

(

)

Get mob play counter.

Returns

int counter

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

Referenced by increasePlayCounter(), and update().

        {
                return $this->mob_cnt_play;
        }

Here is the caller graph for this function:

getNewsForRefId()

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

Get News For Ref Id.

Parameters

int	$a_ref_id
bool	$a_only_public
bool	$a_stopnesting
int	$a_time_period
bool	$a_prevent_aggregation
bool	$a_forum_group_sequences
bool	$a_no_auto_generated
bool	$a_ignore_date_filter
null	$a_user_id
int	$a_limit	currently only supported for groups and courses
	int[]	$a_excluded currently only supported for groups and courses (news ids)

Returns

array|mixed

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

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

Referenced by getAggregatedChildNewsData().

        {
                $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" || $obj_type == "cat")
                {
                        include_once("./Services/Block/classes/class.ilBlockSetting.php");
                        $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);
                }
                else if (($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);
                        $unset = array();
                        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);
                }
                else if ($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:

getPlaytime()

ilNewsItem::getPlaytime

(

)

Get Playtime.

Returns

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

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

References $playtime.

Referenced by create(), and update().

        {
                return $this->playtime;
        }

Here is the caller graph for this function:

getPriority()

ilNewsItem::getPriority

(

)

Get Priority.

Returns

int News Priority

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

References $priority.

Referenced by create(), and update().

        {
                return $this->priority;
        }

Here is the caller graph for this function:

getPrivateFeedId()

static ilNewsItem::getPrivateFeedId ( )

static

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

References $privFeedId.

Referenced by _getNewsItemsOfUser(), queryNewsForContext(), and queryNewsForMultipleContexts().

                                            {

                return ilNewsItem::$privFeedId;
        }

Here is the caller graph for this function:

getTitle()

ilNewsItem::getTitle

(

)

Get Title.

Returns

string Title of news item.

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

References $title.

Referenced by create(), and update().

        {
                return $this->title;
        }

Here is the caller graph for this function:

getUpdateDate()

ilNewsItem::getUpdateDate

(

)

Get UpdateDate.

Returns

string Date of last update.

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

References $update_date.

        {
                return $this->update_date;
        }

getUpdateUserId()

ilNewsItem::getUpdateUserId

(

)

Get update user id.

Returns

int update user id

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

References $update_user_id.

Referenced by create(), and update().

        {
                return $this->update_user_id;
        }

Here is the caller graph for this function:

getUserId()

ilNewsItem::getUserId

(

)

Get UserId.

Returns

int User Id of last update.

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

References $user_id.

Referenced by create(), and update().

        {
                return $this->user_id;
        }

Here is the caller graph for this function:

getVisibility()

ilNewsItem::getVisibility

(

)

Get Visibility.

Returns

string Access level of news.

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

References $visibility.

Referenced by create(), and update().

        {
                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

mixed

$a_time_period

Returns

string

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

References date, and time.

        {
                // 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
                else if(preg_match("/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/", $a_time_period))
                {                       
                        return $a_time_period;
                }
                // :TODO: what to return?               
        }

increaseDownloadCounter()

ilNewsItem::increaseDownloadCounter

(

)

Increase download counter.

Parameters

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

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

Referenced by deliverMobFile().

        {
                global $ilDB;

                $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.

Parameters

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

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

        {
                global $ilDB;

                $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 (   $n1,   $n2  )

static

Merges two sets of news.

Parameters

array	$n1	Array of news
array	$n2	Array of news

Returns

array Array of news

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

References $id.

Referenced by _getNewsItemsOfUser(), getAggregatedChildNewsData(), and getAggregatedNewsData().

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

Here is the caller graph for this function:

prepareNewsDataFromCache()

static ilNewsItem::prepareNewsDataFromCache (   $a_cres )

static

Prepare news data from cache.

Parameters

string

$a_cres

cache string

Returns

array news array

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

References $data, $ilDB, and array.

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

        {
                global $ilDB;

                $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 = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $existing_ids[] = $rec["id"];
                }
                //var_dump($existing_ids);
                $existing_news = array();
                foreach ($data as $k => $v)
                {
                        if (in_array($k, $existing_ids))
                        {
                                $existing_news[$k] = $v;
                        }
                }

                //var_dump($data);
                //var_dump($existing_news);

                return $existing_news;
        }

Here is the caller graph for this function:

queryNewsForContext()

ilNewsItem::queryNewsForContext	(		$a_for_rss_use = false,
			$a_time_period = 0,
			$a_starting_date = "",
			$a_no_auto_generated = false,
			$a_oldest_first = false,
			$a_limit = 0
	)

Query news for a context.

Parameters

boolean	query for outgoing rss feed
int	time period in seconds
string	startind date
boolean	do not include auto generated news items

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

References $ilDB, $ilUser, $lng, $query, $result, ilBlockSetting\_lookup(), array, getContextObjId(), getContextObjType(), getContextSubObjId(), getContextSubObjType(), getPrivateFeedId(), and NEWS_PUBLIC.

        {
                global $ilDB, $ilUser, $lng;

                $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");
                }

                $ordering = ($a_oldest_first)
            ? " creation_date ASC, id ASC "
            : " creation_date DESC, id DESC ";

                if ($a_for_rss_use && ilNewsItem::getPrivateFeedId() == false)
                {
                        $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 (ilNewsItem::getPrivateFeedId() != false) 
                {
                        $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(ilNewsItem::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 = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        if ($a_limit > 0 && count($result) >= $a_limit)
                        {
                                continue;
                        }
                        if (!$a_for_rss_use ||  (ilNewsItem::getPrivateFeedId() != false) || ($rec["visibility"] == NEWS_PUBLIC ||
                                ($rec["priority"] == 0 &&
                                ilBlockSetting::_lookup("news", "public_notifications",
                                0, $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)
                {
                        include_once("./Services/Block/classes/class.ilBlockSetting.php");
                        $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, $keep_rss_min);
                        }
                }

                return $result;

        }

Here is the call graph for this function:

queryNewsForMultipleContexts()

ilNewsItem::queryNewsForMultipleContexts	(		$a_contexts,
			$a_for_rss_use = false,
			$a_time_period = 0,
			$a_starting_date = "",
			$a_no_auto_generated = false,
			$a_user_id = null,
			$a_limit = 0,
			$a_exclude = array()
	)

Query News for multiple Contexts.

Parameters

array	$a_contexts
bool	$a_for_rss_use
int	$a_time_period
string	$a_starting_date
bool	$a_no_auto_generated
null	$a_user_id
int	$a_limit
	int[]	$a_exclude

Returns

array

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

References $ilCtrl, $ilDB, $ilUser, $lng, $query, $result, $user_id, ilBlockSetting\_lookup(), array, getPrivateFeedId(), and NEWS_PUBLIC.

Referenced by getAggregatedChildNewsData(), and getAggregatedNewsData().

        {
                global $ilDB, $ilUser, $lng, $ilCtrl;

                $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 = array();
                $type = array();

                foreach($a_contexts as $cont)
                {
                        $ids[] = $cont["obj_id"];
                        $type[$cont["obj_id"]] = $cont["obj_type"];
                }
                
                if ($a_for_rss_use && ilNewsItem::getPrivateFeedId() == false)
                {
                        $query = "SELECT * ".
                                "FROM il_news_item ".
                                " WHERE ".
                                        $ilDB->in("context_obj_id", $ids, false, "integer")." ".
                                        $and.
                    " ORDER BY creation_date DESC ";
                }
                elseif (ilNewsItem::getPrivateFeedId() != false) 
                {
                        $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(ilNewsItem::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 = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        if ($type[$rec["context_obj_id"]] == $rec["context_obj_type"])
                        {
                                if (!$a_for_rss_use || ilNewsItem::getPrivateFeedId() != false || ($rec["visibility"] == NEWS_PUBLIC ||
                                        ($rec["priority"] == 0 &&
                                        ilBlockSetting::_lookup("news", "public_notifications",
                                        0, $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.

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

References $ilDB, $query, 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().

        {
                global $ilDB;

                $query = "SELECT * FROM il_news_item WHERE id = ".
                        $ilDB->quote($this->getId(), "integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);

                $this->setTitle($rec["title"]);
                $this->setContent($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($rec["context_sub_obj_type"]);
                $this->setContentType($rec["content_type"]);
                $this->setCreationDate($rec["creation_date"]);
                $this->setUpdateDate($rec["update_date"]);
                $this->setUserId($rec["user_id"]);
                $this->setUpdateUserId($rec["update_user_id"]);
                $this->setVisibility($rec["visibility"]);
                $this->setContentLong($rec["content_long"]);
                $this->setPriority($rec["priority"]);
                $this->setContentIsLangVar($rec["content_is_lang_var"]);
                $this->setContentTextIsLangVar((int) $rec["content_text_is_lang_var"]);
                $this->setMobId($rec["mob_id"]);
                $this->setPlaytime($rec["playtime"]);
                $this->setMobPlayCounter($rec["mob_cnt_play"]);
                $this->setMobDownloadCounter($rec["mob_cnt_download"]);
                $this->setContentHtml($rec["content_html"]);

        }

Here is the call graph for this function:

Here is the caller graph for this function:

setContent()

ilNewsItem::setContent

(

$a_content

)

Set Content.

Parameters

string

$a_content

Content of news.

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

References $a_content.

Referenced by read().

        {
                $this->content = $a_content;
        }

Here is the caller graph for this function:

setContentHtml()

ilNewsItem::setContentHtml

(

$a_val

)

Is content HTML (tiny used?)

Parameters

bool

$a_val

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

Referenced by read().

        {
                $this->content_html = $a_val;
        }

Here is the caller graph for this function:

setContentIsLangVar()

ilNewsItem::setContentIsLangVar

(

$a_content_is_lang_var = 0

)

Set ContentIsLangVar.

Parameters

boolean

$a_content_is_lang_var

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

Referenced by read().

        {
                $this->content_is_lang_var = $a_content_is_lang_var;
        }

Here is the caller graph for this function:

setContentLong()

ilNewsItem::setContentLong

(

$a_content_long

)

Set ContentLong.

Parameters

string

$a_content_long

Long content of news

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

Referenced by read().

        {
                $this->content_long = $a_content_long;
        }

Here is the caller graph for this function:

setContentTextIsLangVar()

ilNewsItem::setContentTextIsLangVar

(

$a_val = 0

)

Set content text ist lang var.

Parameters

boolean

$a_content_is_lang_var

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

Referenced by read().

        {
                $this->content_text_is_lang_var = $a_val;
        }

Here is the caller graph for this function:

setContentType()

ilNewsItem::setContentType

(

$a_content_type = "text"

)

Set ContentType.

Parameters

string

$a_content_type

Content type.

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

Referenced by read().

        {
                $this->content_type = $a_content_type;
        }

Here is the caller graph for this function:

setContext()

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

Convenient function to set the whole context information.

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

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

        {
                $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

(

$a_context_obj_id

)

Set ContextObjId.

Parameters

int

$a_context_obj_id

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

Referenced by read(), and setContext().

        {
                $this->context_obj_id = $a_context_obj_id;
        }

Here is the caller graph for this function:

setContextObjType()

ilNewsItem::setContextObjType

(

$a_context_obj_type

)

Set ContextObjType.

Parameters

int

$a_context_obj_type

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

Referenced by read(), and setContext().

        {
                $this->context_obj_type = $a_context_obj_type;
        }

Here is the caller graph for this function:

setContextSubObjId()

ilNewsItem::setContextSubObjId

(

$a_context_sub_obj_id

)

Set ContextSubObjId.

Parameters

int

$a_context_sub_obj_id

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

Referenced by read(), and setContext().

        {
                $this->context_sub_obj_id = $a_context_sub_obj_id;
        }

Here is the caller graph for this function:

setContextSubObjType()

ilNewsItem::setContextSubObjType

(

$a_context_sub_obj_type

)

Set ContextSubObjType.

Parameters

int

$a_context_sub_obj_type

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

Referenced by read(), and setContext().

        {
                $this->context_sub_obj_type = $a_context_sub_obj_type;
        }

Here is the caller graph for this function:

setCreationDate()

ilNewsItem::setCreationDate

(

$a_creation_date

)

Set CreationDate.

Parameters

string

$a_creation_date

Date of creation.

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

Referenced by read().

        {
                $this->creation_date = $a_creation_date;
        }

Here is the caller graph for this function:

setId()

ilNewsItem::setId

(

$a_id

)

Set Id.

Parameters

int

$a_id

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

Referenced by __construct(), and create().

        {
                $this->id = $a_id;
        }

Here is the caller graph for this function:

setLimitation()

ilNewsItem::setLimitation

(

$a_limitation

)

Set Limitation for number of items.

Parameters

boolean

$a_limitation

Limitation for number of items

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

        {
                $this->limitation = $a_limitation;
        }

setMobDownloadCounter()

ilNewsItem::setMobDownloadCounter

(

$a_val

)

Set mob download counter.

Parameters

int

$a_val

counter

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

Referenced by increaseDownloadCounter(), and read().

        {
                $this->mob_cnt_download = $a_val;
        }

Here is the caller graph for this function:

setMobId()

ilNewsItem::setMobId

(

$a_mob_id

)

Set MobId.

Parameters

int

$a_mob_id

Media Object ID (if news includes attachement)

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

Referenced by read().

        {
                $this->mob_id = $a_mob_id;
        }

Here is the caller graph for this function:

setMobPlayCounter()

ilNewsItem::setMobPlayCounter

(

$a_val

)

Set mob play counter.

Parameters

int

$a_val

counter

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

Referenced by increasePlayCounter(), and read().

        {
                $this->mob_cnt_play = $a_val;
        }

Here is the caller graph for this function:

setPlaytime()

ilNewsItem::setPlaytime

(

$a_playtime

)

Set Playtime.

Parameters

string

$a_playtime

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

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

Referenced by read().

        {
                $this->playtime = $a_playtime;
        }

Here is the caller graph for this function:

setPriority()

ilNewsItem::setPriority

(

$a_priority = 1

)

Set Priority.

Parameters

int

$a_priority

News Priority

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

Referenced by read().

        {
                $this->priority = $a_priority;
        }

Here is the caller graph for this function:

setPrivateFeedId()

static ilNewsItem::setPrivateFeedId (   $a_userId )

static

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

References $privFeedId.

Referenced by ilObjectFeedWriter\__construct().

        {
                ilNewsItem::$privFeedId = $a_userId;
        }

Here is the caller graph for this function:

setTitle()

ilNewsItem::setTitle

(

$a_title

)

Set Title.

Parameters

string

$a_title

Title of news item.

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

Referenced by read().

        {
                $this->title = $a_title;
        }

Here is the caller graph for this function:

setUpdateDate()

ilNewsItem::setUpdateDate

(

$a_update_date

)

Set UpdateDate.

Parameters

string

$a_update_date

Date of last update.

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

Referenced by read().

        {
                $this->update_date = $a_update_date;
        }

Here is the caller graph for this function:

setUpdateUserId()

ilNewsItem::setUpdateUserId

(

$a_val

)

Set update user id.

Parameters

int

$a_val

update user id

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

Referenced by read().

        {
                $this->update_user_id = $a_val;
        }

Here is the caller graph for this function:

setUserId()

ilNewsItem::setUserId

(

$a_user_id

)

Set UserId.

Parameters

int

$a_user_id

User Id of last update.

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

Referenced by read().

        {
                $this->user_id = $a_user_id;
        }

Here is the caller graph for this function:

setVisibility()

ilNewsItem::setVisibility

(

$a_visibility = "users"

)

Set Visibility.

Parameters

string

$a_visibility

Access level of news.

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

Referenced by read().

        {
                $this->visibility = $a_visibility;
        }

Here is the caller graph for this function:

update()

ilNewsItem::update

(

$a_as_new = false

)

Update item in database.

Parameters

boolean

$a_as_new

If true, creation date is set "now"

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

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

        {
                global $ilDB;

                $fields = array(
                        "title" => array("text", $this->getTitle()),
                        "content" => array("clob", $this->getContent()),
                        "content_html" => array("integer", (int) $this->getContentHtml()),
                        "context_obj_id" => array("integer", $this->getContextObjId()),
                        "context_obj_type" => array("text", $this->getContextObjType()),
                        "context_sub_obj_id" => array("integer", $this->getContextSubObjId()),
                        "context_sub_obj_type" => array("text", $this->getContextSubObjType()),
                        "content_type" => array("text", $this->getContentType()),
                        "user_id" => array("integer", $this->getUserId()),
                        "update_user_id" => array("integer", (int) $this->getUpdateUserId()),
                        "visibility" => array("text", $this->getVisibility()),
                        "content_long" => array("clob", $this->getContentLong()),
                        "priority" => array("integer", $this->getPriority()),
                        "content_is_lang_var" => array("integer", $this->getContentIsLangVar()),
                        "content_text_is_lang_var" => array("integer", (int) $this->getContentTextIsLangVar()),
                        "mob_id" => array("integer", $this->getMobId()),
                        "mob_cnt_play" => array("integer", $this->getMobPlayCounter()),
                        "mob_cnt_download" => array("integer", $this->getMobDownloadCounter()),
            "playtime" => array("text", $this->getPlaytime())
                );

                $now = ilUtil::now();
                if ($a_as_new)
                {
                        $fields["creation_date"] = array("timestamp", $now);
                        $fields["update_date"] = array("timestamp", $now);
                }
                else
                {
                        $fields["update_date"] = array("timestamp", $now);
                }

                $ilDB->update("il_news_item", $fields, array(
                        "id" => array("integer", $this->getId())
                ));

        }

Here is the call graph for this function:

Field Documentation

$content

ilNewsItem::$content

protected

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

Referenced by getContent().

$content_html

ilNewsItem::$content_html

protected

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

Referenced by getContentHtml().

$content_is_lang_var

ilNewsItem::$content_is_lang_var = 0

protected

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

Referenced by getContentIsLangVar().

$content_long

ilNewsItem::$content_long

protected

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

Referenced by getContentLong().

$content_type

ilNewsItem::$content_type = "text"

protected

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

Referenced by getContentType().

$context_obj_id

ilNewsItem::$context_obj_id

protected

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

Referenced by getContextObjId().

$context_obj_type

ilNewsItem::$context_obj_type

protected

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

Referenced by getContextObjType().

$context_sub_obj_id

ilNewsItem::$context_sub_obj_id

protected

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

Referenced by getContextSubObjId().

$context_sub_obj_type

ilNewsItem::$context_sub_obj_type

protected

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

Referenced by getContextSubObjType().

$creation_date

ilNewsItem::$creation_date

protected

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

Referenced by getCreationDate().

$id

ilNewsItem::$id

protected

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

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

$limitation

ilNewsItem::$limitation

private

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

Referenced by getLimitation().

$mob_id

ilNewsItem::$mob_id

protected

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

Referenced by getMobId().

$playtime

ilNewsItem::$playtime

protected

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

Referenced by getPlaytime().

$priority

ilNewsItem::$priority = 1

protected

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

Referenced by getPriority().

$privFeedId

ilNewsItem::$privFeedId = false

staticprivate

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

Referenced by getPrivateFeedId(), and setPrivateFeedId().

$title

ilNewsItem::$title

protected

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

Referenced by getTitle().

$update_date

ilNewsItem::$update_date

protected

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

Referenced by getUpdateDate().

$update_user_id

ilNewsItem::$update_user_id

protected

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

Referenced by getUpdateUserId().

$user_id

ilNewsItem::$user_id

protected

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

Referenced by getUserId(), and queryNewsForMultipleContexts().

$visibility

ilNewsItem::$visibility = "users"

protected

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

Referenced by _getDefaultVisibilityForRefId(), and getVisibility().

---

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

• Services/News/classes/class.ilNewsItem.php