diff options
| -rw-r--r-- | actions/favoritesrss.php | 80 |
1 files changed, 60 insertions, 20 deletions
diff --git a/actions/favoritesrss.php b/actions/favoritesrss.php index 3f4ffc63a..19339325c 100644 --- a/actions/favoritesrss.php +++ b/actions/favoritesrss.php @@ -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); } - -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 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; } -}
\ No newline at end of file +} + |