lib/noticesection.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for sections showing lists 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  Widget
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('GNUSOCIAL') && !defined('GNUSOCIAL')) { exit(1); }
  31
  32 define('NOTICES_PER_SECTION', 6);
  33
  34 /**
  35  * Base class for sections showing lists of notices
  36  *
  37  * These are the widgets that show interesting data about a person
  38  * group, or site.
  39  *
  40  * @todo migrate this to use a variant of NoticeList
  41  *
  42  * @category Widget
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  */
  48
  49 abstract class NoticeSection extends Section
  50 {
  51     protected $addressees = false;
  52     protected $attachments = false;
  53     protected $maxchars = 140;
  54     protected $options = false;
  55     protected $show_n = NOTICES_PER_SECTION;
  56
  57     function showContent()
  58     {
  59         $prefs = array();
  60         foreach (array('addressees', 'attachments', 'maxchars', 'options', 'show_n') as $key) {
  61             $prefs[$key] = $this->$key;
  62         }
  63         $prefs['id_prefix'] = $this->divId();
  64
  65         // args: notice object, html outputter, preference array for notice lists and their items
  66         $list = new NoticeList($this->getNotices(), $this->out, $prefs);
  67         $total = $list->show(); // returns total amount of notices available
  68         return ($total > $this->show_n);  // do we have more to show?
  69     }
  70
  71     function getNotices()
  72     {
  73         return null;
  74     }
  75 }