Merge branch 'locshunt' into 0.9.x

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

diff --git a/actions/favoritesrss.php b/actions/favoritesrss.php
index 25dd3861fa29fed97076d0bcad6974bd5ffc0e18..62f06e841b193ddd2cb4f94fbb47a3c6c151050e 100644 (file)
--- a/actions/favoritesrss.php
+++ b/actions/favoritesrss.php
@@ -1,7 +1,19 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+
+/**
+ * RSS feed for user favorites action class.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Robin Millette <millette@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * 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
@@ -17,57 +29,102 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/rssaction.php');
+require_once INSTALLDIR.'/lib/rssaction.php';
 
-// Formatting of RSS handled by Rss10Action
-
-class FavoritesrssAction extends Rss10Action {
+/**
+ * RSS feed for user favorites action class.
+ *
+ * Formatting of RSS handled by Rss10Action
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Robin Millette <millette@status.net>
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ */
+class FavoritesrssAction extends Rss10Action
+{
 
-       var $user = NULL;
-       
-       function init() {
-               $nickname = $this->trimmed('nickname');
-               $this->user = User::staticGet('nickname', $nickname);
+    /** The user whose favorites to display */
 
-               if (!$this->user) {
-                       common_user_error(_('No such user.'));
-                       return false;
-               } else {
-                       return true;
-               }
-       }
+    var $user = null;
 
-       function get_notices($limit=0) {
+    /**
+     * Find the user to display by supplied nickname
+     *
+     * @param array $args Arguments from $_REQUEST
+     *
+     * @return boolean success
+     */
 
-               $user = $this->user;
+    function prepare($args)
+    {
+        parent::prepare($args);
 
-               $notice = $user->favoriteNotices(0, $limit);
+        $nickname   = $this->trimmed('nickname');
+        $this->user = User::staticGet('nickname', $nickname);
 
-               $notices = array();
+        if (!$this->user) {
+            $this->clientError(_('No such user.'));
+            return false;
+        } else {
+            $this->notices = $this->getNotices($this->limit);
+            return true;
+        }
+    }
 
-               while ($notice->fetch()) {
-                       $notices[] = clone($notice);
-               }
+    /**
+     * 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);
+        $notices = array();
+        while ($notice->fetch()) {
+            $notices[] = clone($notice);
+        }
+        return $notices;
+    }
 
-               return $notices;
-       }
+     /**
+     * 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)),
+                   'title' => sprintf(_("%s's favorite notices"), $user->nickname),
+                   'link' => common_local_url('showfavorites',
+                                        array('nickname' =>
+                                        $user->nickname)),
+                   'description' => sprintf(_('Updates favored by %1$s on %2$s!'),
+                                        $user->nickname, common_config('site', 'name')));
+        return $c;
+    }
 
-       function get_channel() {
-               $user = $this->user;
-               $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));
-               return $c;
-       }
+    /**
+     * Get image.
+     *
+     * @return void
+    */
+    function getImage()
+    {
+        return null;
+    }
 
-       function get_image() {
-               return NULL;
-       }
-}
\ No newline at end of file
+}