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('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); }
  32
  33 /**
  34  * widget for displaying a list of notices
  35  *
  36  * There are a number of actions that display a list of notices, in
  37  * reverse chronological order. This widget abstracts out most of the
  38  * code for UI for notice lists. It's overridden to hide some
  39  * data for e.g. the profile page.
  40  *
  41  * @category UI
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  * @see      Notice
  47  * @see      NoticeListItem
  48  * @see      ProfileNoticeList
  49  */
  50 class NoticeList extends Widget
  51 {
  52     /** the current stream of notices being displayed. */
  53
  54     var $notice = null;
  55
  56     protected $addressees = true;
  57     protected $attachments = true;
  58     protected $id_prefix = null;
  59     protected $maxchars = 0;
  60     protected $options = true;
  61     protected $show_n = NOTICES_PER_PAGE;
  62
  63     /**
  64      * constructor
  65      *
  66      * @param Notice $notice stream of notices from DB_DataObject
  67      */
  68     function __construct(Notice $notice, Action $out=null, array $prefs=array())
  69     {
  70         parent::__construct($out);
  71         $this->notice = $notice;
  72
  73         // integer preferences
  74         foreach(array('show_n', 'maxchars') as $key) {
  75             if (array_key_exists($key, $prefs)) {
  76                 $this->$key = (int)$prefs[$key];
  77             }
  78         }
  79         // boolean preferences
  80         foreach(array('addressees', 'attachments', 'options') as $key) {
  81             if (array_key_exists($key, $prefs)) {
  82                 $this->$key = (bool)$prefs[$key];
  83             }
  84         }
  85         // string preferences
  86         foreach(array('id_prefix') as $key) {
  87             if (array_key_exists($key, $prefs)) {
  88                 $this->$key = $prefs[$key];
  89             }
  90         }
  91     }
  92
  93     /**
  94      * show the list of notices
  95      *
  96      * "Uses up" the stream by looping through it. So, probably can't
  97      * be called twice on the same list.
  98      *
  99      * @param integer $n    The amount of notices to show.
 100      *
 101      * @return int  Total amount of notices actually available.
 102      */
 103     public function show()
 104     {
 105         $this->out->elementStart('ol', array('class' => 'notices xoxo'));
 106
 107                 $notices = $this->notice->fetchAll();
 108                 $total   = count($notices);
 109                 $notices = array_slice($notices, 0, $this->show_n);
 110
 111         self::prefill($notices);
 112
 113         foreach ($notices as $notice) {
 114
 115             try {
 116                 $item = $this->newListItem($notice);
 117                 $item->show();
 118             } catch (Exception $e) {
 119                 // we log exceptions and continue
 120                 common_log(LOG_ERR, $e->getMessage());
 121                 continue;
 122             }
 123         }
 124
 125         $this->out->elementEnd('ol');
 126         return $total;
 127     }
 128
 129     /**
 130      * returns a new list item for the current notice
 131      *
 132      * Recipe (factory?) method; overridden by sub-classes to give
 133      * a different list item class.
 134      *
 135      * @param Notice $notice the current notice
 136      *
 137      * @return NoticeListItem a list item for displaying the notice
 138      */
 139     function newListItem(Notice $notice)
 140     {
 141         $prefs = array('addressees' => $this->addressees,
 142                        'attachments' => $this->attachments,
 143                        'id_prefix' => $this->id_prefix,
 144                        'maxchars' => $this->maxchars,
 145                        'options' => $this->options);
 146         return new NoticeListItem($notice, $this->out, $prefs);
 147     }
 148
 149     static function prefill(array &$notices)
 150     {
 151         $scoped = Profile::current();
 152         $notice_ids = Notice::_idsOf($notices);
 153
 154         if (Event::handle('StartNoticeListPrefill', array(&$notices, $notice_ids, $scoped))) {
 155
 156             // Prefill attachments
 157             Notice::fillAttachments($notices);
 158             // Prefill the profiles
 159             $profiles = Notice::fillProfiles($notices);
 160
 161             Event::handle('EndNoticeListPrefill', array(&$notices, &$profiles, $notice_ids, $scoped));
 162         }
 163     }
 164 }