lib/section.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for sections (sidebar widgets)
   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('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/widget.php';
  35
  36 /**
  37  * Base class for sections
  38  *
  39  * These are the widgets that show interesting data about a person
  40  * group, or site.
  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 class Section extends Widget
  50 {
  51     /**
  52      * Show the form
  53      *
  54      * Uses a recipe to output the form.
  55      *
  56      * @return void
  57      * @see Widget::show()
  58      */
  59
  60     function show()
  61     {
  62         $this->out->elementStart('div',
  63                                  array('id' => $this->divId(),
  64                                        'class' => 'section'));
  65
  66         $this->out->element('h2', null,
  67                             $this->title());
  68
  69         $have_more = $this->showContent();
  70
  71         if ($have_more) {
  72             $this->out->elementStart('p');
  73             $this->out->element('a', array('href' => $this->moreUrl(),
  74                                       'class' => 'more'),
  75                            $this->moreTitle());
  76             $this->out->elementEnd('p');
  77         }
  78
  79         $this->out->elementEnd('div');
  80     }
  81
  82     function divId()
  83     {
  84         return 'generic_section';
  85     }
  86
  87     function title()
  88     {
  89         return _('Untitled section');
  90     }
  91
  92     function showContent()
  93     {
  94         $this->out->element('p', null,
  95                             _('(None)'));
  96         return false;
  97     }
  98
  99     function moreUrl()
 100     {
 101         return null;
 102     }
 103
 104     function moreTitle()
 105     {
 106         return _('More...');
 107     }
 108 }