uiredesign + phpdocs

This commit is contained in:
Robin Millette 2009-01-22 05:08:18 +00:00 committed by Robin Millette
parent 205eb386c5
commit e38f6165b6

View File

@ -1,5 +1,17 @@
<?php
/*
/**
* Public RSS 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,17 +29,34 @@
* 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 and friends timeline.
*
* 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 AllrssAction extends Rss10Action
{
var $user = null;
/**
* Initialization.
*
* @return boolean false if user doesn't exist
*/
function init()
{
$nickname = $this->trimmed('nickname');
@ -41,11 +70,16 @@ class AllrssAction 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->noticesWithFriends(0, $limit);
while ($notice->fetch()) {
@ -55,7 +89,12 @@ class AllrssAction extends Rss10Action
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('allrss',
@ -69,7 +108,12 @@ class AllrssAction extends Rss10Action
return $c;
}
function get_image()
/**
* Get image.
*
* @return string user avatar URL or null
*/
function getImage()
{
$user = $this->user;
$profile = $user->getProfile();
@ -77,6 +121,7 @@ class AllrssAction extends Rss10Action
return null;
}
$avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
return ($avatar) ? $avatar->url : null;
return $avatar ? $avatar->url : null;
}
}