X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=actions%2Ffavoritesrss.php;h=f85bf1b19002f288a04fd2175ee7c94f6f4c5435;hb=5e816d7be208fc24419288234559c78da7391c8b;hp=8c7ce52bf16c667a1786383a092e79376a172bfa;hpb=b264c03d32d04d7a33d28a5830848660f4484943;p=quix0rs-gnu-social.git

diff --git a/actions/favoritesrss.php b/actions/favoritesrss.php
index 8c7ce52bf1..f85bf1b190 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,62 +29,101 @@
  * 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>
+ * @author   Zach Copley <zach@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://laconi.ca/
+ */
 class FavoritesrssAction extends Rss10Action
 {
-
-    var $user = null;
     
-    function init()
+    /** The user whose favorites to display */
+    
+    var $user = null;
+        
+    /**
+     * Find the user to display by supplied nickname
+     *
+     * @param array $args Arguments from $_REQUEST
+     *
+     * @return boolean success
+     */
+
+    function prepare($args)
     {
-        $nickname = $this->trimmed('nickname');
+        parent::prepare($args);
+        
+        $nickname   = $this->trimmed('nickname');
         $this->user = User::staticGet('nickname', $nickname);
 
         if (!$this->user) {
-            common_user_error(_('No such user.'));
+            $this->clientError(_('No such user.'));
             return false;
         } else {
             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)
     {
-
-        $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',
-                                             array('nickname' =>
-                                                   $user->nickname)),
+        $c    = array('url' => common_local_url('favoritesrss',
+                                        array('nickname' =>
+                                        $user->nickname)),
                    'title' => sprintf(_("%s favorite notices"), $user->nickname),
                    'link' => common_local_url('showfavorites',
-                                             array('nickname' =>
-                                                   $user->nickname)),
-                   'description' => sprintf(_('Feed of favorite notices of %s'), $user->nickname));
+                                        array('nickname' =>
+                                        $user->nickname)),
+                   'description' => sprintf(_('Feed of favorite notices of %s'), 
+                                        $user->nickname));
         return $c;
     }
 
-    function get_image()
+    /**
+     * Get image.
+     *
+     * @return void
+    */
+    function getImage()
     {
         return null;
     }
-}
\ No newline at end of file
+
+}