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 Evan Prodromou <evan@status.net>
25 * @author Sarven Capadisli <csarven@status.net>
26 * @copyright 2008 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 require_once INSTALLDIR.'/lib/favorform.php';
36 require_once INSTALLDIR.'/lib/disfavorform.php';
37 require_once INSTALLDIR.'/lib/attachmentlist.php';
40 * widget for displaying a list of notices
42 * There are a number of actions that display a list of notices, in
43 * reverse chronological order. This widget abstracts out most of the
44 * code for UI for notice lists. It's overridden to hide some
45 * data for e.g. the profile page.
49 * @author Evan Prodromou <evan@status.net>
50 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
51 * @link http://status.net/
54 * @see ProfileNoticeList
56 class NoticeList extends Widget
58 /** the current stream of notices being displayed. */
65 * @param Notice $notice stream of notices from DB_DataObject
67 function __construct($notice, $out=null)
69 parent::__construct($out);
70 $this->notice = $notice;
74 * show the list of notices
76 * "Uses up" the stream by looping through it. So, probably can't
77 * be called twice on the same list.
79 * @return int count of notices listed.
83 $this->out->elementStart('div', array('id' =>'notices_primary'));
84 // TRANS: Header in notice list.
85 $this->out->element('h2', null, _m('HEADER','Notices'));
86 $this->out->elementStart('ol', array('class' => 'notices xoxo'));
90 while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
93 if ($cnt > NOTICES_PER_PAGE) {
98 $item = $this->newListItem($this->notice);
100 } catch (Exception $e) {
101 // we log exceptions and continue
102 common_log(LOG_ERR, $e->getMessage());
107 $this->out->elementEnd('ol');
108 $this->out->elementEnd('div');
114 * returns a new list item for the current notice
116 * Recipe (factory?) method; overridden by sub-classes to give
117 * a different list item class.
119 * @param Notice $notice the current notice
121 * @return NoticeListItem a list item for displaying the notice
123 function newListItem($notice)
125 return new NoticeListItem($notice, $this->out);