3 * StatusNet, the distributed open-source microblogging tool
5 * widget for displaying a list of notices
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Brion Vibber <brion@status.net>
25 * @copyright 2011 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 * widget for displaying a list of notices
37 * There are a number of actions that display a list of notices, in
38 * reverse chronological order. This widget abstracts out most of the
39 * code for UI for notice lists. It's overridden to hide some
40 * data for e.g. the profile page.
44 * @author Evan Prodromou <evan@status.net>
45 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
46 * @link http://status.net/
49 * @see ProfileNoticeList
52 class ThreadedNoticeList extends NoticeList
55 * show the list of notices
57 * "Uses up" the stream by looping through it. So, probably can't
58 * be called twice on the same list.
60 * @return int count of notices listed.
65 $this->out->elementStart('div', array('id' =>'notices_primary'));
66 $this->out->element('h2', null, _('Notices'));
67 $this->out->elementStart('ol', array('class' => 'notices xoxo'));
70 $conversations = array();
71 while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
74 if ($cnt > NOTICES_PER_PAGE) {
78 $convo = $this->notice->conversation;
79 if (!empty($conversations[$convo])) {
80 // Seen this convo already -- skip!
83 $conversations[$convo] = true;
85 // Get the convo's root notice
86 // @fixme stream goes in wrong direction, this needs sane caching
87 //$notice = Notice::conversationStream($convo, 0, 1);
89 $notice = new Notice();
90 $notice->conversation = $this->notice->conversation;
91 $notice->orderBy('CREATED');
96 $item = $this->newListItem($notice);
98 } catch (Exception $e) {
99 // we log exceptions and continue
100 common_log(LOG_ERR, $e->getMessage());
105 $this->out->elementEnd('ol');
106 $this->out->elementEnd('div');
112 * returns a new list item for the current notice
114 * Recipe (factory?) method; overridden by sub-classes to give
115 * a different list item class.
117 * @param Notice $notice the current notice
119 * @return NoticeListItem a list item for displaying the notice
122 function newListItem($notice)
124 return new ThreadedNoticeListItem($notice, $this->out);
129 * widget for displaying a single notice
131 * This widget has the core smarts for showing a single notice: what to display,
132 * where, and under which circumstances. Its key method is show(); this is a recipe
133 * that calls all the other show*() methods to build up a single notice. The
134 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
135 * author info (since that's implicit by the data in the page).
139 * @author Evan Prodromou <evan@status.net>
140 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
141 * @link http://status.net/
143 * @see ProfileNoticeListItem
146 class ThreadedNoticeListItem extends NoticeListItem
148 const INITIAL_ITEMS = 3;
153 * Close the last elements in the notice list item
160 if (!$this->repeat) {
161 $notice = Notice::conversationStream($this->notice->conversation, 0, self::INITIAL_ITEMS + 2);
165 while ($notice->fetch()) {
166 if ($notice->id == $this->notice->id) {
171 if ($cnt > self::INITIAL_ITEMS) {
173 $moreCutoff = clone($notice);
176 $notices[] = clone($notice); // *grumble* inefficient as hell
180 $this->out->elementStart('ul', 'notices threaded-notices xoxo');
182 $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out);
185 foreach (array_reverse($notices) as $notice) {
186 $item = new ThreadedNoticeListSubItem($notice, $this->out);
189 $this->out->elementEnd('ul');
197 class ThreadedNoticeListSubItem extends NoticeListItem
200 function avatarSize()
202 return AVATAR_STREAM_SIZE; // @fixme would like something in between
205 function showNoticeLocation()
210 function showNoticeSource()
217 * Placeholder for loading more replies...
219 class ThreadedNoticeListMoreItem extends NoticeListItem
223 * recipe function for displaying a single notice.
225 * This uses all the other methods to correctly display a notice. Override
226 * it or one of the others to fine-tune the output.
234 $this->showMiniForm();
239 * start a single notice.
246 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
247 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
248 $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
252 function showMiniForm()
254 $id = $this->notice->conversation;
255 $url = common_local_url('conversation', array('id' => $id)) . '#notice-' . $this->notice->id;
257 $notice = new Notice();
258 $notice->conversation = $id;
259 $n = $notice->count() - 1;
260 $msg = sprintf(_m('Show all %d comment', 'Show all %d comments', $n), $n);
262 $this->out->element('a', array('href' => $url), $msg);
264 // @fixme replace this with an ajax-friendly form pair?
266 $this->out->elementStart('form',
268 'class' => 'replyform',
271 $this->out->hidden('token', common_session_token());
272 $this->out->hidden("$id-inreplyto", $replyToId, "inreplyto");
273 $this->out->element('textarea', array('name' => 'status_textarea'));
274 $this->out->elementStart('div', array('class' => 'controls'));
275 $this->out->submit("$id-submit", _m('Send reply'));
276 $this->out->elementEnd('div');
277 $this->out->elementEnd('form');