]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/widget.php
fix notices in dumpschema
[quix0rs-gnu-social.git] / lib / widget.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Base class for UI 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  * @author    Sarven Capadisli <csarven@status.net>
26  * @copyright 2009 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('STATUSNET') && !defined('LACONICA')) {
32     exit(1);
33 }
34
35 /**
36  * Base class for UI widgets
37  *
38  * A widget is a cluster of HTML elements that provide some functionality
39  * that's used on different parts of the site. Examples would be profile
40  * lists, notice lists, navigation menus (tabsets) and common forms.
41  *
42  * @category Widget
43  * @package  StatusNet
44  * @author   Evan Prodromou <evan@status.net>
45  * @author   Sarven Capadisli <csarven@status.net>
46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47  * @link     http://status.net/
48  *
49  * @see      HTMLOutputter
50  */
51
52 class Widget
53 {
54     /**
55      * HTMLOutputter to use for output
56      */
57
58     var $out = null;
59
60     /**
61      * Prepare the widget for use
62      *
63      * @param HTMLOutputter $out output helper, defaults to null
64      */
65
66     function __construct($out=null)
67     {
68         $this->out = $out;
69     }
70
71     /**
72      * Show the widget
73      *
74      * Emit the HTML for the widget, using the configured outputter.
75      *
76      * @return void
77      */
78
79     function show()
80     {
81     }
82 }