]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/section.php
Merge remote-tracking branch 'origin/1.0.x' into 1.0.x
[quix0rs-gnu-social.git] / 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') && !defined('LACONICA')) {
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 class Section extends Widget
49 {
50     /**
51      * Show the form
52      *
53      * Uses a recipe to output the form.
54      *
55      * @return void
56      * @see Widget::show()
57      */
58     function show()
59     {
60         $this->out->elementStart('div',
61                                  array('id' => $this->divId(),
62                                        'class' => 'section'));
63
64         $this->showTitle();
65
66         $have_more = $this->showContent();
67
68         if ($have_more) {
69             $this->showMore();
70         }
71
72         $this->out->elementEnd('div');
73     }
74
75     function showTitle()
76     {
77         $link = $this->link();
78         if (!empty($link)) {
79             $this->out->elementStart('h2');
80             $this->out->element('a', array('href' => $link), $this->title());
81             $this->out->elementEnd('h2');
82         } else {
83             $this->out->element('h2', null,
84                                 $this->title());
85         }
86     }
87
88     function showMore()
89     {
90         $this->out->elementStart('p');
91         $this->out->element('a', array('href' => $this->moreUrl(),
92                                        'class' => 'more'),
93                             $this->moreTitle());
94         $this->out->elementEnd('p');
95     }
96
97     function divId()
98     {
99         return 'generic_section';
100     }
101
102     function title()
103     {
104         // TRANS: Default title for section/sidebar widget.
105         return _('Untitled section');
106     }
107
108     function link()
109     {
110         return null;
111     }
112
113     function showContent()
114     {
115         $this->out->element('p', null,
116                             // TRANS: Default content for section/sidebar widget.
117                             _('(None)'));
118         return false;
119     }
120
121     function moreUrl()
122     {
123         return null;
124     }
125
126     function moreTitle()
127     {
128         // TRANS: Default "More..." title for section/sidebar widget.
129         return _('More...');
130     }
131 }