isReadOnly() now takes arguments

[quix0rs-gnu-social.git] / actions / publicrss.php

diff --git a/actions/publicrss.php b/actions/publicrss.php
index 93314ee326dda0a03eeb51f66fcf76f26c9433c2..bc52f29522778483220c7994605b5b552c928502 100644 (file)
--- 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,53 +29,82 @@
  * 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';
+
+/**
+ * RSS feed for public 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 PublicrssAction extends Rss10Action
+{
+    /**
+     * Initialization.
+     * 
+     * @return boolean true
+     */
+    function init()
+    {
+        return true;
+    }
 
-require_once(INSTALLDIR.'/lib/rssaction.php');
+    /**
+     * 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);
+        while ($notice->fetch()) {
+            $notices[] = clone($notice);
+        }
+        
+        return $notices;
+    }
 
-// Formatting of RSS handled by Rss10Action
+     /**
+     * Get channel.
+     *
+     * @return array associative array on channel information
+     */
+    function getChannel()
+    {
+        $c = array(
+              'url' => common_local_url('publicrss')
+            , 'title' => sprintf(_('%s Public Stream'), common_config('site', 'name'))
+            , 'link' => common_local_url('public')
+            , 'description' => sprintf(_('All updates for %s'), common_config('site', 'name')));
+        return $c;
+    }
 
-class PublicrssAction extends Rss10Action {
+    /**
+     * Get image.
+     *
+     * @return nothing
+    */
+    function getImage()
+    {
+        // nop
+    }
 
-       function init() {
-               return true;
-       }
-       
-       function get_notices($limit=0) {
-               
-               $user = $this->user;
-               $notices = array();
-               
-               $notice = DB_DataObject::factory('notice');
+    function isReadOnly($args)
+    {
+        return true;
+    }
+}
 
-               # FIXME: bad performance
-               
-               $notice->whereAdd('EXISTS (SELECT user.id from user where user.id = notice.profile_id)');
-               
-               $notice->orderBy('created DESC');
-               
-               if ($limit != 0) {
-                       $notice->limit(0, $limit);
-               }
-               $notice->find();
-               
-               while ($notice->fetch()) {
-                       $notices[] = clone($notice);
-               }
-               
-               return $notices;
-       }
-       
-       function get_channel() {
-               global $config;
-               $c = array('url' => common_local_url('publicrss'),
-                                  'title' => $config['site']['name'] . _t(' Public Stream'),
-                                  'link' => common_local_url('public'),
-                                  'description' => _t('All updates for ') . $config['site']['name']);
-               return $c;
-       }
-       
-       function get_image() {
-               return NULL;
-       }
-}
\ No newline at end of file