actions/favoritesrss.php

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