lib/noticelist.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * widget for displaying a list of notices
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  UI
  23  * @package   StatusNet
  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/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/favorform.php';
  36 require_once INSTALLDIR.'/lib/disfavorform.php';
  37 require_once INSTALLDIR.'/lib/attachmentlist.php';
  38
  39 /**
  40  * widget for displaying a list of notices
  41  *
  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.
  46  *
  47  * @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  * @see      Notice
  53  * @see      NoticeListItem
  54  * @see      ProfileNoticeList
  55  */
  56 class NoticeList extends Widget
  57 {
  58     /** the current stream of notices being displayed. */
  59
  60     var $notice = null;
  61
  62     /**
  63      * constructor
  64      *
  65      * @param Notice $notice stream of notices from DB_DataObject
  66      */
  67     function __construct($notice, $out=null)
  68     {
  69         parent::__construct($out);
  70         $this->notice = $notice;
  71     }
  72
  73     /**
  74      * show the list of notices
  75      *
  76      * "Uses up" the stream by looping through it. So, probably can't
  77      * be called twice on the same list.
  78      *
  79      * @return int count of notices listed.
  80      */
  81     function show()
  82     {
  83         $this->out->elementStart('div', array('id' =>'notices_primary'));
  84         $this->out->elementStart('ol', array('class' => 'notices xoxo'));
  85
  86         $cnt = 0;
  87
  88         while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
  89             $cnt++;
  90
  91             if ($cnt > NOTICES_PER_PAGE) {
  92                 break;
  93             }
  94
  95             try {
  96                 $item = $this->newListItem($this->notice);
  97                 $item->show();
  98             } catch (Exception $e) {
  99                 // we log exceptions and continue
 100                 common_log(LOG_ERR, $e->getMessage());
 101                 continue;
 102             }
 103         }
 104
 105         $this->out->elementEnd('ol');
 106         $this->out->elementEnd('div');
 107
 108         return $cnt;
 109     }
 110
 111     /**
 112      * returns a new list item for the current notice
 113      *
 114      * Recipe (factory?) method; overridden by sub-classes to give
 115      * a different list item class.
 116      *
 117      * @param Notice $notice the current notice
 118      *
 119      * @return NoticeListItem a list item for displaying the notice
 120      */
 121     function newListItem($notice)
 122     {
 123         return new NoticeListItem($notice, $this->out);
 124     }
 125 }