]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/widget.php
use none instead of unset
[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     protected $avatarSize = AVATAR_STREAM_SIZE;
55
56     /**
57      * Action (HTMLOutputter) to use for output
58      */
59
60     var $out = null;
61
62     /**
63      * Prepare the widget for use
64      *
65      * @param Action $out output helper, defaults to null
66      */
67
68     function __construct(Action $out=null)
69     {
70         $this->out = $out;
71     }
72
73     /**
74      * Show the widget
75      *
76      * Emit the HTML for the widget, using the configured outputter.
77      *
78      * @return void
79      */
80
81     function show()
82     {
83     }
84
85     /**
86      * Get HTMLOutputter
87      *
88      * Return the HTMLOutputter for the widget.
89      *
90      * @return HTMLOutputter the output helper
91      */
92
93     function getOut()
94     {
95         return $this->out;
96     }
97
98     /**
99      * Delegate output methods to the outputter attribute.
100      *
101      * @param string $name      Name of the method
102      * @param array  $arguments Arguments called
103      *
104      * @return mixed Return value of the method.
105      */
106     function __call($name, $arguments)
107     {
108         return call_user_func_array(array($this->out, $name), $arguments);
109     }
110
111     /**
112      * Default avatar size for this widget.
113      */
114     public function avatarSize()
115     {
116         return $this->avatarSize;
117     }
118
119     protected function showAvatar(Profile $profile, $size=null)
120     {
121         $avatar_url = $profile->avatarUrl($size ?: $this->avatarSize());
122         $this->out->element('img', array('src' => $avatar_url,
123                                          'class' => 'avatar u-photo',
124                                          'width' => $this->avatarSize(),
125                                          'height' => $this->avatarSize(),
126                                          'alt' => $profile->getBestName()));
127     }
128 }