summaryrefslogtreecommitdiff
path: root/actions/favoritesrss.php
diff options
context:
space:
mode:
authorEvan Prodromou <git@evanprodromou.name>2009-01-23 08:58:31 +0100
committerEvan Prodromou <git@evanprodromou.name>2009-01-23 08:58:31 +0100
commita7c85bebd5be9ea019a8c80d74730d7eb28d4651 (patch)
treec3fdf9575a342624bc71aad1d439ae73594f558c /actions/favoritesrss.php
parent4873277b58941ae6ec16543f437f4267ccab5ac0 (diff)
parent7aa496cd8a939960eeaf79f3397f6fe94097e047 (diff)
Merge branch 'master' of /var/www/mublog
Conflicts: actions/api.php actions/deletenotice.php actions/recoverpassword.php actions/remotesubscribe.php actions/tag.php actions/tagrss.php actions/twitapiaccount.php actions/twitapiusers.php classes/Notice.php classes/User.php lib/common.php lib/language.php lib/subs.php lib/twitterapi.php lib/util.php scripts/inbox_users.php scripts/update_translations.php Merged development trunk into laconica head. woohoo!
Diffstat (limited to 'actions/favoritesrss.php')
-rw-r--r--actions/favoritesrss.php143
1 files changed, 94 insertions, 49 deletions
diff --git a/actions/favoritesrss.php b/actions/favoritesrss.php
index 25dd3861f..19339325c 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,57 +29,90 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-if (!defined('LACONICA')) { exit(1); }
-
-require_once(INSTALLDIR.'/lib/rssaction.php');
-
-// Formatting of RSS handled by Rss10Action
-
-class FavoritesrssAction extends Rss10Action {
+if (!defined('LACONICA')) {
+ exit(1);
+}
- var $user = NULL;
-
- function init() {
- $nickname = $this->trimmed('nickname');
- $this->user = User::staticGet('nickname', $nickname);
+require_once INSTALLDIR.'/lib/rssaction.php';
- if (!$this->user) {
- common_user_error(_('No such user.'));
- return false;
- } else {
- return true;
- }
- }
-
- function get_notices($limit=0) {
-
- $user = $this->user;
-
- $notice = $user->favoriteNotices(0, $limit);
-
- $notices = array();
+/**
+ * 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>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://laconi.ca/
+ */
+class FavoritesrssAction extends Rss10Action
+{
+ var $user = null;
+
+ /**
+ * Initialization.
+ *
+ * @return boolean false if user doesn't exist
+ */
+ function init()
+ {
+ $nickname = $this->trimmed('nickname');
+ $this->user = User::staticGet('nickname', $nickname);
+ if (!$this->user) {
+ $this->clientError(_('No such user.'));
+ return false;
+ } else {
+ 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 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;
+ }
- 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 voir
+ */
+ function getImage()
+ {
+ return null;
+ }
+}
- function get_image() {
- return NULL;
- }
-} \ No newline at end of file