<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+
+/**
+ * Public RSS action class.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package StatusNet
+ * @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/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* 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');
+require_once INSTALLDIR.'/lib/rssaction.php';
-// Formatting of RSS handled by Rss10Action
-
-class PublicrssAction extends Rss10Action {
-
- function init() {
+/**
+ * RSS feed for public timeline.
+ *
+ * Formatting of RSS handled by Rss10Action
+ *
+ * @category Action
+ * @package StatusNet
+ * @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);
}
return $notices;
}
- function get_channel() {
- 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']));
+ /**
+ * Get channel.
+ *
+ * @return array associative array on channel information
+ */
+ function getChannel()
+ {
+ $c = array(
+ 'url' => common_local_url('publicrss')
+ , 'title' => sprintf(_('%s public timeline'), common_config('site', 'name'))
+ , 'link' => common_local_url('public')
+ , 'description' => sprintf(_('%s updates from everyone!'), common_config('site', 'name')));
return $c;
}
- function get_image() {
- return null;
+ /**
+ * Get image.
+ *
+ * @return nothing
+ */
+ function getImage()
+ {
+ // nop
}
-}
\ No newline at end of file
+
+ function isReadOnly($args)
+ {
+ return true;
+ }
+}
+