diff options
| -rw-r--r-- | actions/publicrss.php | 80 |
1 files changed, 61 insertions, 19 deletions
diff --git a/actions/publicrss.php b/actions/publicrss.php index 822bc2db7..b98c27205 100644 --- a/actions/publicrss.php +++ b/actions/publicrss.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,27 +29,45 @@ * 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'; +/** + * 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 PublicrssAction extends Rss10Action { - + /** + * Initialization. + * + * @return boolean true + */ function init() { return true; } - function get_notices($limit=0) + /** + * Get notices + * + * @param integer $limit max number of notices to return + * + * @return array notices + */ + function getNotices($limit=0) { - $notices = array(); - - $notice = Notice::publicStream(0, ($limit == 0) ? 48 : $limit); - + $notice = Notice::publicStream(0, ($limit == 0) ? 48 : $limit); while ($notice->fetch()) { $notices[] = clone($notice); } @@ -45,18 +75,30 @@ class PublicrssAction extends Rss10Action return $notices; } - function get_channel() + /** + * Get channel. + * + * @return array associative array on channel information + */ + function getChannel() { global $config; - $c = array('url' => common_local_url('publicrss'), - 'title' => sprintf(_('%s Public Stream'), $config['site']['name']), - 'link' => common_local_url('public'), - 'description' => sprintf(_('All updates for %s'), $config['site']['name'])); + $c = array( + 'url' => common_local_url('publicrss') + , 'title' => sprintf(_('%s Public Stream'), $config['site']['name']) + , 'link' => common_local_url('public') + , 'description' => sprintf(_('All updates for %s'), $config['site']['name'])); return $c; } - function get_image() + /** + * Get image. + * + * @return nothing + */ + function getImage() { - return null; + // nop } -}
\ No newline at end of file +} + |