gnu-social/lib/widget.php

131 lines
3.6 KiB
PHP
Raw Normal View History

2009-01-14 04:54:55 +00:00
<?php
/**
* StatusNet, the distributed open-source microblogging tool
2009-01-14 04:54:55 +00:00
*
* Base class for UI widgets
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Widget
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @copyright 2009 StatusNet, Inc.
2009-01-14 04:54:55 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
2009-08-25 23:16:46 +01:00
* @link http://status.net/
2009-01-14 04:54:55 +00:00
*/
2016-01-20 15:10:10 +00:00
if (!defined('GNUSOCIAL')) { exit(1); }
2009-01-14 04:54:55 +00:00
/**
* Base class for UI widgets
*
2009-01-14 04:56:10 +00:00
* A widget is a cluster of HTML elements that provide some functionality
* that's used on different parts of the site. Examples would be profile
* lists, notice lists, navigation menus (tabsets) and common forms.
2009-01-14 04:54:55 +00:00
*
* @category Widget
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Sarven Capadisli <csarven@status.net>
2009-01-14 04:54:55 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
2009-08-25 23:16:46 +01:00
* @link http://status.net/
2009-01-14 04:54:55 +00:00
*
* @see HTMLOutputter
*/
class Widget
{
protected $avatarSize = AVATAR_STREAM_SIZE;
2009-01-14 04:54:55 +00:00
/**
* Action (HTMLOutputter) to use for output
2009-01-14 04:54:55 +00:00
*/
var $out = null;
/**
* Prepare the widget for use
*
* @param Action $out output helper, defaults to null
2009-01-14 04:54:55 +00:00
*/
2016-01-20 15:10:10 +00:00
function __construct(Action $out=null, array $widgetOpts=array())
2009-01-14 04:54:55 +00:00
{
$this->out = $out;
2016-01-20 15:10:10 +00:00
if (!array_key_exists('scoped', $widgetOpts)) {
$this->widgetOpts['scoped'] = Profile::current();
}
$this->scoped = $this->widgetOpts['scoped'];
2009-01-14 04:54:55 +00:00
}
/**
* Show the widget
*
* Emit the HTML for the widget, using the configured outputter.
*
* @return void
*/
function show()
{
}
2012-03-07 22:06:33 +00:00
/**
* Get HTMLOutputter
*
* Return the HTMLOutputter for the widget.
*
* @return HTMLOutputter the output helper
*/
function getOut()
{
return $this->out;
}
/**
* Delegate output methods to the outputter attribute.
*
* @param string $name Name of the method
* @param array $arguments Arguments called
*
* @return mixed Return value of the method.
*/
function __call($name, $arguments)
{
return call_user_func_array(array($this->out, $name), $arguments);
}
/**
* Default avatar size for this widget.
*/
public function avatarSize()
{
return $this->avatarSize;
}
protected function showAvatar(Profile $profile, $size=null)
{
$avatar_url = $profile->avatarUrl($size ?: $this->avatarSize());
$this->out->element('img', array('src' => $avatar_url,
'class' => 'avatar u-photo',
'width' => $this->avatarSize(),
'height' => $this->avatarSize(),
'alt' => $profile->getBestName()));
}
2009-01-14 04:54:55 +00:00
}