lib/messagelist.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * The message list widget
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Widget
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Message list widget
  39  *
  40  * @category  Widget
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 abstract class MessageList extends Widget
  49 {
  50     var $message;
  51
  52     /**
  53      * Constructor
  54      *
  55      * @param HTMLOutputter $out     Output context
  56      * @param Message       $message Stream of messages to show
  57      */
  58     function __construct($out, $message)
  59     {
  60         parent::__construct($out);
  61         $this->message = $message;
  62     }
  63
  64     /**
  65      * Show the widget
  66      *
  67      * Uses newItem() to create each new item.
  68      *
  69      * @return integer count of messages seen.
  70      */
  71     function show()
  72     {
  73             $cnt = 0;
  74
  75             $this->out->elementStart('div', array('id' =>'notices_primary'));
  76
  77             $this->out->element('h2', null, _('Messages'));
  78
  79             $this->out->elementStart('ul', 'notices messages');
  80
  81             while ($this->message->fetch() && $cnt <= MESSAGES_PER_PAGE) {
  82
  83                 $cnt++;
  84
  85                 if ($cnt > MESSAGES_PER_PAGE) {
  86                     break;
  87                 }
  88
  89                 $mli = $this->newItem($this->message);
  90
  91                 $mli->show();
  92             }
  93
  94             $this->out->elementEnd('ul');
  95
  96             $this->out->elementEnd('div');
  97     }
  98
  99     /**
 100      * Create a new message item for a message
 101      *
 102      * @param Message $message The message to show
 103      *
 104      * @return MessageListItem an item to show
 105      */
 106     abstract function newItem($message);
 107 }