3 * StatusNet, the distributed open-source microblogging tool
5 * Base class for UI widgets
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.
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.
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/>.
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/
31 if (!defined('GNUSOCIAL')) { exit(1); }
34 * Base class for UI widgets
36 * A widget is a cluster of HTML elements that provide some functionality
37 * that's used on different parts of the site. Examples would be profile
38 * lists, notice lists, navigation menus (tabsets) and common forms.
42 * @author Evan Prodromou <evan@status.net>
43 * @author Sarven Capadisli <csarven@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://status.net/
52 protected $avatarSize = AVATAR_STREAM_SIZE;
55 * Action (HTMLOutputter) to use for output
61 * Prepare the widget for use
63 * @param Action $out output helper, defaults to null
66 function __construct(Action $out=null, array $widgetOpts=array())
69 if (!array_key_exists('scoped', $widgetOpts)) {
70 $this->widgetOpts['scoped'] = Profile::current();
72 $this->scoped = $this->widgetOpts['scoped'];
78 * Emit the HTML for the widget, using the configured outputter.
90 * Return the HTMLOutputter for the widget.
92 * @return HTMLOutputter the output helper
101 * Delegate output methods to the outputter attribute.
103 * @param string $name Name of the method
104 * @param array $arguments Arguments called
106 * @return mixed Return value of the method.
108 function __call($name, $arguments)
110 return call_user_func_array(array($this->out, $name), $arguments);
114 * Default avatar size for this widget.
116 public function avatarSize()
118 return $this->avatarSize;
121 protected function showAvatar(Profile $profile, $size=null)
123 $avatar_url = $profile->avatarUrl($size ?: $this->avatarSize());
124 $this->out->element('img', array('src' => $avatar_url,
125 'class' => 'avatar u-photo',
126 'width' => $this->avatarSize(),
127 'height' => $this->avatarSize(),
128 'alt' => $profile->getBestName()));