]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/favoritesrss.php
Give NoticeListItem its own class
[quix0rs-gnu-social.git] / 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('STATUSNET') && !defined('LACONICA')) {
32     exit(1);
33 }
34
35 require_once INSTALLDIR.'/lib/rssaction.php';
36
37 /**
38  * RSS feed for user favorites action class.
39  *
40  * Formatting of RSS handled by Rss10Action
41  *
42  * @category Action
43  * @package  StatusNet
44  * @author   Evan Prodromou <evan@status.net>
45  * @author   Robin Millette <millette@status.net>
46  * @author   Zach Copley <zach@status.net>
47  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
48  * @link     http://status.net/
49  */
50 class FavoritesrssAction extends Rss10Action
51 {
52     /** The user whose favorites to display */
53
54     var $user = null;
55
56     /**
57      * Find the user to display by supplied nickname
58      *
59      * @param array $args Arguments from $_REQUEST
60      *
61      * @return boolean success
62      */
63     function prepare($args)
64     {
65         parent::prepare($args);
66
67         $nickname   = $this->trimmed('nickname');
68         $this->user = User::staticGet('nickname', $nickname);
69
70         if (!$this->user) {
71             // TRANS: Client error displayed when trying to get the RSS feed with favorites of a user that does not exist.
72             $this->clientError(_('No such user.'));
73             return false;
74         } else {
75             $this->notices = $this->getNotices($this->limit);
76             return true;
77         }
78     }
79
80     /**
81      * Get notices
82      *
83      * @param integer $limit max number of notices to return
84      *
85      * @return array notices
86      */
87     function getNotices($limit=0)
88     {
89         $user    = $this->user;
90         $notice  = $user->favoriteNotices(false, 0, $limit);
91         $notices = array();
92         while ($notice->fetch()) {
93             $notices[] = clone($notice);
94         }
95         return $notices;
96     }
97
98      /**
99      * Get channel.
100      *
101      * @return array associative array on channel information
102      */
103     function getChannel()
104     {
105         $user = $this->user;
106         $c    = array('url' => common_local_url('favoritesrss',
107                                         array('nickname' =>
108                                         $user->nickname)),
109                    // TRANS: Title of RSS feed with favourite notices of a user.
110                    // TRANS: %s is a user's nickname.
111                    'title' => sprintf(_("%s's favorite notices"), $user->nickname),
112                    'link' => common_local_url('showfavorites',
113                                         array('nickname' =>
114                                         $user->nickname)),
115                    // TRANS: Desciption of RSS feed with favourite notices of a user.
116                    // TRANS: %1$s is a user's nickname, %2$s is the name of the StatusNet site.
117                    'description' => sprintf(_('Updates favored by %1$s on %2$s!'),
118                                         $user->nickname, common_config('site', 'name')));
119         return $c;
120     }
121
122     /**
123      * Get image.
124      *
125      * @return void
126     */
127     function getImage()
128     {
129         return null;
130     }
131
132 }