uiredesign + phpdocs

This commit is contained in:
Robin Millette 2009-01-22 15:20:58 +00:00 committed by Robin Millette
parent a2a2dd88b5
commit cb2e374bc2

View File

@ -1,5 +1,17 @@
<?php
/*
/**
* RSS feed for user favorites action class.
*
* PHP version 5
*
* @category Action
* @package Laconica
* @author Evan Prodromou <evan@controlyourself.ca>
* @author Robin Millette <millette@controlyourself.ca>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://laconi.ca/
*
* Laconica - a distributed open-source microblogging tool
* Copyright (C) 2008, Controlez-Vous, Inc.
*
@ -17,22 +29,37 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('LACONICA')) { exit(1); }
if (!defined('LACONICA')) {
exit(1);
}
require_once(INSTALLDIR.'/lib/rssaction.php');
// Formatting of RSS handled by Rss10Action
require_once INSTALLDIR.'/lib/rssaction.php';
/**
* RSS feed for user favorites action class.
*
* Formatting of RSS handled by Rss10Action
*
* @category Action
* @package Laconica
* @author Evan Prodromou <evan@controlyourself.ca>
* @author Robin Millette <millette@controlyourself.ca>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://laconi.ca/
*/
class FavoritesrssAction extends Rss10Action
{
var $user = null;
/**
* Initialization.
*
* @return boolean false if user doesn't exist
*/
function init()
{
$nickname = $this->trimmed('nickname');
$nickname = $this->trimmed('nickname');
$this->user = User::staticGet('nickname', $nickname);
if (!$this->user) {
$this->clientError(_('No such user.'));
return false;
@ -41,26 +68,33 @@ class FavoritesrssAction extends Rss10Action
}
}
function get_notices($limit=0)
/**
* Get notices
*
* @param integer $limit max number of notices to return
*
* @return array notices
*/
function getNotices($limit=0)
{
$user = $this->user;
$notice = $user->favoriteNotices(0, $limit);
$user = $this->user;
$notice = $user->favoriteNotices(0, $limit);
$notices = array();
while ($notice->fetch()) {
$notices[] = clone($notice);
}
return $notices;
}
function get_channel()
/**
* Get channel.
*
* @return array associative array on channel information
*/
function getChannel()
{
$user = $this->user;
$c = array('url' => common_local_url('favoritesrss',
$c = array('url' => common_local_url('favoritesrss',
array('nickname' =>
$user->nickname)),
'title' => sprintf(_("%s favorite notices"), $user->nickname),
@ -71,8 +105,14 @@ class FavoritesrssAction extends Rss10Action
return $c;
}
function get_image()
/**
* Get image.
*
* @return voir
*/
function getImage()
{
return null;
}
}