noticelist.php 3.63 KB
Newer Older
1
<?php
2
/**
3
 * StatusNet, the distributed open-source microblogging tool
4
 *
5
 * widget for displaying a list of notices
6 7 8 9
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
10 11 12 13 14 15
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 18 19
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
20 21 22
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  UI
23
 * @package   StatusNet
24 25
 * @author    Evan Prodromou <evan@status.net>
 * @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/
29 30
 */

31
if (!defined('STATUSNET') && !defined('LACONICA')) {
32 33 34
    exit(1);
}

35 36
require_once INSTALLDIR.'/lib/favorform.php';
require_once INSTALLDIR.'/lib/disfavorform.php';
37
require_once INSTALLDIR.'/lib/attachmentlist.php';
38

39 40 41 42 43 44 45 46 47
/**
 * widget for displaying a list of notices
 *
 * There are a number of actions that display a list of notices, in
 * reverse chronological order. This widget abstracts out most of the
 * code for UI for notice lists. It's overridden to hide some
 * data for e.g. the profile page.
 *
 * @category UI
48
 * @package  StatusNet
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/
52 53 54 55
 * @see      Notice
 * @see      NoticeListItem
 * @see      ProfileNoticeList
 */
56
class NoticeList extends Widget
57 58
{
    /** the current stream of notices being displayed. */
59

60
    var $notice = null;
61

62 63 64 65 66
    /**
     * constructor
     *
     * @param Notice $notice stream of notices from DB_DataObject
     */
67
    function __construct($notice, $out=null)
68
    {
Evan Prodromou's avatar
Evan Prodromou committed
69
        parent::__construct($out);
70 71 72
        $this->notice = $notice;
    }

73 74 75
    /**
     * show the list of notices
     *
76
     * "Uses up" the stream by looping through it. So, probably can't
77 78 79 80 81 82
     * be called twice on the same list.
     *
     * @return int count of notices listed.
     */
    function show()
    {
sarven's avatar
sarven committed
83
        $this->out->elementStart('div', array('id' =>'notices_primary'));
84
        $this->out->elementStart('ol', array('class' => 'notices xoxo'));
85

86
        $cnt = 0;
87

88 89
        while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
            $cnt++;
90

91 92 93
            if ($cnt > NOTICES_PER_PAGE) {
                break;
            }
94

95 96 97 98 99 100 101 102
            try {
                $item = $this->newListItem($this->notice);
                $item->show();
            } catch (Exception $e) {
                // we log exceptions and continue
                common_log(LOG_ERR, $e->getMessage());
                continue;
            }
103
        }
104

105
        $this->out->elementEnd('ol');
sarven's avatar
sarven committed
106
        $this->out->elementEnd('div');
107 108

        return $cnt;
109
    }
110

111 112 113 114 115 116 117 118 119 120 121 122
    /**
     * returns a new list item for the current notice
     *
     * Recipe (factory?) method; overridden by sub-classes to give
     * a different list item class.
     *
     * @param Notice $notice the current notice
     *
     * @return NoticeListItem a list item for displaying the notice
     */
    function newListItem($notice)
    {
123
        return new NoticeListItem($notice, $this->out);
124 125
    }
}