ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions
ilUserFeedWriter Class Reference
Services/Feeds

Feed writer for personal user feeds. More...

+ Inheritance diagram for ilUserFeedWriter:
+ Collaboration diagram for ilUserFeedWriter:

Public Member Functions

 ilUserFeedWriter ($a_user_id, $a_hash, $privFeed=false)
 
- Public Member Functions inherited from ilFeedWriter
 ilFeedWriter ()
 
 setEncoding ($a_enc)
 Set feed encoding. More...
 
 getEncoding ()
 
 setChannelAbout ($a_ab)
 Unique URI that defines the channel. More...
 
 getChannelAbout ()
 
 setChannelTitle ($a_title)
 Channel Title. More...
 
 getChannelTitle ()
 
 setChannelLink ($a_link)
 Channel Link URL to which an HTML rendering of the channel title will link. More...
 
 getChannelLink ()
 
 setChannelDescription ($a_desc)
 Channel Description. More...
 
 getChannelDescription ()
 
 addItem ($a_item)
 Add Item Item is an object of type ilFeedItem. More...
 
 getItems ()
 
 prepareStr ($a_str)
 
 getFeed ()
 get feed xml More...
 
 showFeed ()
 
 getContextPath ($a_ref_id)
 

Additional Inherited Members

- Data Fields inherited from ilFeedWriter
 $encoding = "UTF-8"
 
 $ch_about = ""
 
 $ch_title = ""
 
 $ch_link = ""
 
 $ch_description = ""
 
 $items = array()
 

Detailed Description

Feed writer for personal user feeds.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 19 of file class.ilUserFeedWriter.php.

Member Function Documentation

◆ ilUserFeedWriter()

ilUserFeedWriter::ilUserFeedWriter (   $a_user_id,
  $a_hash,
  $privFeed = false 
)

Definition at line 22 of file class.ilUserFeedWriter.php.

References $ilSetting, ilFeedWriter\$items, $lng, ilNewsItem\_getNewsItemsOfUser(), ilObjUser\_lookupFeedHash(), ilObject\_lookupObjId(), ilObjMediaCastAccess\_lookupOnline(), ilNewsItem\_lookupRSSPeriod(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilFeedWriter\addItem(), ilNewsItem\determineNewsContent(), ilNewsItem\determineNewsTitle(), ilFeedWriter\getContextPath(), ilWikiPage\lookupTitle(), ilFeedWriter\prepareStr(), ilFeedWriter\setChannelAbout(), ilFeedWriter\setChannelLink(), and ilFeedWriter\setChannelTitle().

23  {
24  global $ilSetting, $lng;
25 
26  parent::ilFeedWriter();
27 
28  //$lng->loadLanguageModule("news");
29 
30  if ($a_user_id == "" || $a_hash == "")
31  {
32  return;
33  }
34 
35  $news_set = new ilSetting("news");
36  if (!$news_set->get("enable_rss_for_internal"))
37  {
38  return;
39  }
40 
41  include_once "Services/User/classes/class.ilObjUser.php";
42  $hash = ilObjUser::_lookupFeedHash($a_user_id);
43 
44  include_once("./Services/News/classes/class.ilNewsItem.php");
45  $rss_period = ilNewsItem::_lookupRSSPeriod();
46 
47  if ($a_hash == $hash)
48  {
49  if ($privFeed)
50  {
51  //ilNewsItem::setPrivateFeedId($a_user_id);
52  $items = ilNewsItem::_getNewsItemsOfUser($a_user_id, false, true, $rss_period);
53  }
54  else
55  {
56  $items = ilNewsItem::_getNewsItemsOfUser($a_user_id, true, true, $rss_period);
57  }
58 
59  if ($ilSetting->get('short_inst_name') != "")
60  {
61  $this->setChannelTitle($ilSetting->get('short_inst_name'));
62  }
63  else
64  {
65  $this->setChannelTitle("ILIAS");
66  }
67 
68  $this->setChannelAbout(ILIAS_HTTP_PATH);
69  $this->setChannelLink(ILIAS_HTTP_PATH);
70  //$this->setChannelDescription("ILIAS Channel Description");
71  $i = 0;
72  foreach($items as $item)
73  {
74  $obj_id = ilObject::_lookupObjId($item["ref_id"]);
75  $obj_type = ilObject::_lookupType($obj_id);
76  $obj_title = ilObject::_lookupTitle($obj_id);
77 
78  // not nice, to do: general solution
79  if ($obj_type == "mcst")
80  {
81  include_once("./Modules/MediaCast/classes/class.ilObjMediaCastAccess.php");
82  if (!ilObjMediaCastAccess::_lookupOnline($obj_id))
83  {
84  continue;
85  }
86  }
87 
88  $i++;
89  $feed_item = new ilFeedItem();
90  $title = ilNewsItem::determineNewsTitle
91  ($item["context_obj_type"], $item["title"], $item["content_is_lang_var"],
92  $item["agg_ref_id"], $item["aggregation"]);
93 
94  // path
95  $loc = $this->getContextPath($item["ref_id"]);
96 
97  // title
98  if ($news_set->get("rss_title_format") == "news_obj")
99  {
100  $feed_item->setTitle($this->prepareStr(str_replace("<br />", " ", $title)).
101  " (".$this->prepareStr($loc)." ".$this->prepareStr($obj_title).
102  ")");
103  }
104  else
105  {
106  $feed_item->setTitle($this->prepareStr($loc)." ".$this->prepareStr($obj_title).
107  ": ".$this->prepareStr(str_replace("<br />", " ", $title)));
108  }
109 
110  // description
111  $content = $this->prepareStr(nl2br(
112  ilNewsItem::determineNewsContent($item["context_obj_type"], $item["content"], $item["content_text_is_lang_var"])));
113  $feed_item->setDescription($content);
114 
115  // lm page hack, not nice
116  if (in_array($item["context_obj_type"], array("dbk", "lm")) && $item["context_sub_obj_type"] == "pg"
117  && $item["context_sub_obj_id"] > 0)
118  {
119  $feed_item->setLink(ILIAS_HTTP_PATH."/goto.php?client_id=".CLIENT_ID.
120  "&amp;target=pg_".$item["context_sub_obj_id"]."_".$item["ref_id"]);
121  }
122  else if ($item["context_obj_type"] == "wiki" && $item["context_sub_obj_type"] == "wpg"
123  && $item["context_sub_obj_id"] > 0)
124  {
125  include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
126  $wptitle = ilWikiPage::lookupTitle($item["context_sub_obj_id"]);
127  $feed_item->setLink(ILIAS_HTTP_PATH."/goto.php?client_id=".CLIENT_ID.
128  "&amp;target=".$item["context_obj_type"]."_".$item["ref_id"]."_".urlencode($wptitle)); // #14629
129  }
130  else if (in_array($item["context_obj_type"], array("frm")) && $item["context_sub_obj_type"] == "pos"
131  && $item["context_sub_obj_id"] > 0)
132  {
133  // frm hack, not nice
134  include_once("./Modules/Forum/classes/class.ilObjForumAccess.php");
135  $thread_id = ilObjForumAccess::_getThreadForPosting($item["context_sub_obj_id"]);
136  if ($thread_id > 0)
137  {
138  $feed_item->setLink(ILIAS_HTTP_PATH."/goto.php?client_id=".CLIENT_ID.
139  "&amp;target=".$item["context_obj_type"]."_".$item["ref_id"]."_".$thread_id."_".$item["context_sub_obj_id"]);
140  }
141  else
142  {
143  $feed_item->setLink(ILIAS_HTTP_PATH."/goto.php?client_id=".CLIENT_ID.
144  "&amp;target=".$item["context_obj_type"]."_".$item["ref_id"]);
145  }
146  }
147  else
148  {
149  $feed_item->setLink(ILIAS_HTTP_PATH."/goto.php?client_id=".CLIENT_ID.
150  "&amp;target=".$item["context_obj_type"]."_".$item["ref_id"]);
151  }
152  $feed_item->setAbout($feed_item->getLink()."&amp;il_about_feed=".$item["id"]);
153  $feed_item->setDate($item["creation_date"]);
154  $this->addItem($feed_item);
155  }
156  }
157  }
ilNewsItem\determineNewsTitle
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.
Definition: class.ilNewsItem.php:1234
ilSetting
ILIAS Setting Class.
Definition: class.ilSetting.php:32
ilWikiPage\lookupTitle
static lookupTitle($a_page_id)
Checks whether a page with given title exists.
Definition: class.ilWikiPage.php:464
ilFeedWriter\setChannelLink
setChannelLink($a_link)
Channel Link URL to which an HTML rendering of the channel title will link.
Definition: class.ilFeedWriter.php:81
ilObject\_lookupTitle
static _lookupTitle($a_id)
lookup object title
Definition: class.ilObject.php:944
ilFeedItem
A FeedItem represents an item in a News Feed.
Definition: class.ilFeedItem.php:31
ilFeedWriter\setChannelAbout
setChannelAbout($a_ab)
Unique URI that defines the channel.
Definition: class.ilFeedWriter.php:54
ilNewsItem\determineNewsContent
static determineNewsContent($a_context_obj_type, $a_content, $a_is_lang_var)
Determine new content.
Definition: class.ilNewsItem.php:1309
ilObject\_lookupObjId
static _lookupObjId($a_id)
Definition: class.ilObject.php:1041
ilObject\_lookupType
static _lookupType($a_id, $a_reference=false)
lookup object type
Definition: class.ilObject.php:1196
ilFeedWriter\setChannelTitle
setChannelTitle($a_title)
Channel Title.
Definition: class.ilFeedWriter.php:67
ilNewsItem\_getNewsItemsOfUser
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.
Definition: class.ilNewsItem.php:280
$ilSetting
global $ilSetting
Definition: privfeed.php:40
$lng
global $lng
Definition: privfeed.php:40
ilFeedWriter\getContextPath
getContextPath($a_ref_id)
Definition: class.ilFeedWriter.php:192
ilObjUser\_lookupFeedHash
_lookupFeedHash($a_user_id, $a_create=false)
Lookup news feed hash for user.
Definition: class.ilObjUser.php:4391
ilObjMediaCastAccess\_lookupOnline
_lookupOnline($a_id)
Check wether media cast is online.
Definition: class.ilObjMediaCastAccess.php:132
ilFeedWriter\addItem
addItem($a_item)
Add Item Item is an object of type ilFeedItem.
Definition: class.ilFeedWriter.php:108
+ Here is the call graph for this function:
The documentation for this class was generated from the following file: