X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fallrss.php;h=45f3946a61cfda010765ae3b54ca94360dc4d0a7;hb=34d904b180e5caa17eb945292a8a64656424d5d0;hp=a64b47641462494c15624ffe36a820f2d93b5759;hpb=64ed01f0aff569da2fd4ed589df9ed4ee9852cb7;p=quix0rs-gnu-social.git

diff --git a/actions/allrss.php b/actions/allrss.php
index a64b476414..45f3946a61 100644
--- a/actions/allrss.php
+++ b/actions/allrss.php
@@ -1,5 +1,17 @@
 <?php
-/*
+
+/**
+ * RSS feed for user and friends timeline 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,64 +29,103 @@
  * 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';
 
-class AllrssAction extends Rss10Action {
-
-	var $user = NULL;
+/**
+ * RSS feed for user and friends 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 AllrssAction extends Rss10Action
+{
+    var $user = null;
 
-	function init() {
-		$nickname = $this->trimmed('nickname');
-		$this->user = User::staticGet('nickname', $nickname);
+    /**
+     * Initialization.
+     *
+     * @param array $args Web and URL arguments
+     *
+     * @return boolean false if user doesn't exist
+     */
+    function prepare($args)
+    {
+        parent::prepare($args);
+        $nickname   = $this->trimmed('nickname');
+        $this->user = User::staticGet('nickname', $nickname);
 
-		if (!$this->user) {
-			common_user_error(_('No such user.'));
-			return false;
-		} else {
-			return true;
-		}
-	}
+        if (!$this->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->noticesWithFriends(0, $limit);
+        $notices = array();
 
-		$user = $this->user;
-		
-		$notice = $user->noticesWithFriends();
-		
-		if ($limit != 0) {
-			$notice->limit(0, $limit);
-		}
-		
-		$notice->find();
+        while ($notice->fetch()) {
+            $notices[] = clone($notice);
+        }
 
-		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('allrss',
+                                             array('nickname' =>
+                                                   $user->nickname)),
+                   'title' => sprintf(_('%s and friends'), $user->nickname),
+                   'link' => common_local_url('all',
+                                             array('nickname' =>
+                                                   $user->nickname)),
+                   'description' => sprintf(_('Feed for friends of %s'),
+                                            $user->nickname));
+        return $c;
+    }
 
-	function get_channel() {
-		$user = $this->user;
-		$c = array('url' => common_local_url('allrss',
-											 array('nickname' =>
-												   $user->nickname)),
-				   'title' => sprintf(_('%s and friends'), $user->nickname),
-				   'link' => common_local_url('all',
-											 array('nickname' =>
-												   $user->nickname)),
-				   'description' => sprintf(_('Feed for friends of %s'), $user->nickname));
-		return $c;
-	}
+    /**
+     * Get image.
+     *
+     * @return string user avatar URL or null
+    */
+    function getImage()
+    {
+        $user    = $this->user;
+        $profile = $user->getProfile();
+        if (!$profile) {
+            return null;
+        }
+        $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
+        return $avatar ? $avatar->url : null;
+    }
+}
 
-	function get_image() {
-		$user = $this->user;
-		$profile = $user->getProfile();
-		$avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
-		return ($avatar) ? $avatar->url : NULL;
-	}
-}
\ No newline at end of file