diff options
| -rw-r--r-- | actions/allrss.php | 77 |
1 files changed, 61 insertions, 16 deletions
diff --git a/actions/allrss.php b/actions/allrss.php index 56818d605..bacb343ce 100644 --- a/actions/allrss.php +++ b/actions/allrss.php @@ -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,20 +29,37 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. */ -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/rssaction.php'); +if (!defined('LACONICA')) { + exit(1); +} -// 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'); + $nickname = $this->trimmed('nickname'); $this->user = User::staticGet('nickname', $nickname); if (!$this->user) { @@ -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; - + $user = $this->user; $notice = $user->noticesWithFriends(0, $limit); while ($notice->fetch()) { @@ -55,10 +89,15 @@ 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', + $c = array('url' => common_local_url('allrss', array('nickname' => $user->nickname)), 'title' => sprintf(_('%s and friends'), $user->nickname), @@ -69,14 +108,20 @@ class AllrssAction extends Rss10Action return $c; } - function get_image() + /** + * Get image. + * + * @return string user avatar URL or null + */ + function getImage() { - $user = $this->user; + $user = $this->user; $profile = $user->getProfile(); if (!$profile) { return null; } $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE); - return ($avatar) ? $avatar->url : null; + return $avatar ? $avatar->url : null; } -}
\ No newline at end of file +} + |