plugins/Favorite/actions/favoritesrss.php

   1 <?php
   2 /**
   3  * RSS feed for user favorites action class.
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @author   Robin Millette <millette@status.net>
  11  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  12  * @link     http://status.net/
  13  *
  14  * StatusNet - the distributed open-source microblogging tool
  15  * Copyright (C) 2008, 2009, StatusNet, Inc.
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU Affero General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU Affero General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU Affero General Public License
  28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * RSS feed for user favorites action class.
  35  *
  36  * Formatting of RSS handled by Rss10Action
  37  *
  38  * @category Action
  39  * @package  StatusNet
  40  * @author   Evan Prodromou <evan@status.net>
  41  * @author   Robin Millette <millette@status.net>
  42  * @author   Zach Copley <zach@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  44  * @link     http://status.net/
  45  */
  46 class FavoritesrssAction extends Rss10Action
  47 {
  48     /** The user whose favorites to display */
  49
  50     var $user = null;
  51
  52     /**
  53      * Find the user to display by supplied nickname
  54      *
  55      * @param array $args Arguments from $_REQUEST
  56      *
  57      * @return boolean success
  58      */
  59     function prepare($args)
  60     {
  61         parent::prepare($args);
  62
  63         $nickname   = $this->trimmed('nickname');
  64         $this->user = User::getKV('nickname', $nickname);
  65
  66         if (!$this->user) {
  67             // TRANS: Client error displayed when trying to get the RSS feed with favorites of a user that does not exist.
  68             $this->clientError(_('No such user.'));
  69         } else {
  70             $this->notices = $this->getNotices($this->limit);
  71             return true;
  72         }
  73     }
  74
  75     /**
  76      * Get notices
  77      *
  78      * @param integer $limit max number of notices to return
  79      *
  80      * @return array notices
  81      */
  82     function getNotices($limit=0)
  83     {
  84         $notice  = Fave::stream($this->user->id, 0, $limit, $false);
  85         $notices = array();
  86         while ($notice->fetch()) {
  87             $notices[] = clone($notice);
  88         }
  89         return $notices;
  90     }
  91
  92      /**
  93      * Get channel.
  94      *
  95      * @return array associative array on channel information
  96      */
  97     function getChannel()
  98     {
  99         $user = $this->user;
 100         $c    = array('url' => common_local_url('favoritesrss',
 101                                         array('nickname' =>
 102                                         $user->nickname)),
 103                    // TRANS: Title of RSS feed with favourite notices of a user.
 104                    // TRANS: %s is a user's nickname.
 105                    'title' => sprintf(_("%s's favorite notices"), $user->nickname),
 106                    'link' => common_local_url('showfavorites',
 107                                         array('nickname' =>
 108                                         $user->nickname)),
 109                    // TRANS: Desciption of RSS feed with favourite notices of a user.
 110                    // TRANS: %1$s is a user's nickname, %2$s is the name of the StatusNet site.
 111                    'description' => sprintf(_('Updates favored by %1$s on %2$s!'),
 112                                         $user->nickname, common_config('site', 'name')));
 113         return $c;
 114     }
 115
 116     /**
 117      * Get image.
 118      *
 119      * @return void
 120     */
 121     function getImage()
 122     {
 123         return null;
 124     }
 125
 126 }