X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fpublicrss.php;h=c3587799718b2c40fa33cb29ea661c082f9c4f53;hb=5e816d7be208fc24419288234559c78da7391c8b;hp=fa86de1d96edaaa8167f59676effaf109bd63d1e;hpb=edbc0c665cc65875b4d14b79939233b1c9c06bb6;p=quix0rs-gnu-social.git

diff --git a/actions/publicrss.php b/actions/publicrss.php
index fa86de1d96..c358779971 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,24 +29,47 @@
  * 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  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);
         }
@@ -42,16 +77,35 @@ 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() {
-        return NULL;
+    /**
+     * Get image.
+     *
+     * @return nothing
+    */
+    function getImage()
+    {
+        // nop
     }
-}
\ No newline at end of file
+
+    function isReadOnly()
+    {
+        return true;
+    }
+}
+