]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/allrss.php
Make allrss.php work with phpcs
[quix0rs-gnu-social.git] / actions / allrss.php
1 <?php
2
3 /**
4  * RSS feed for user and friends timeline 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 and friends timeline.
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  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
48  * @link     http://laconi.ca/
49  */
50 class AllrssAction extends Rss10Action
51 {
52     var $user = null;
53
54     /**
55      * Initialization.
56      *
57      * @param array $args Web and URL arguments
58      *
59      * @return boolean false if user doesn't exist
60      */
61     function prepare($args)
62     {
63         parent::prepare($args);
64         $nickname   = $this->trimmed('nickname');
65         $this->user = User::staticGet('nickname', $nickname);
66
67         if (!$this->user) {
68             $this->clientError(_('No such user.'));
69             return false;
70         } else {
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         $user   = $this->user;
85         $notice = $user->noticesWithFriends(0, $limit);
86
87         while ($notice->fetch()) {
88             $notices[] = clone($notice);
89         }
90
91         return $notices;
92     }
93
94      /**
95      * Get channel.
96      *
97      * @return array associative array on channel information
98      */
99     function getChannel()
100     {
101         $user = $this->user;
102         $c    = array('url' => common_local_url('allrss',
103                                              array('nickname' =>
104                                                    $user->nickname)),
105                    'title' => sprintf(_('%s and friends'), $user->nickname),
106                    'link' => common_local_url('all',
107                                              array('nickname' =>
108                                                    $user->nickname)),
109                    'description' => sprintf(_('Feed for friends of %s'),
110                                             $user->nickname));
111         return $c;
112     }
113
114     /**
115      * Get image.
116      *
117      * @return string user avatar URL or null
118     */
119     function getImage()
120     {
121         $user    = $this->user;
122         $profile = $user->getProfile();
123         if (!$profile) {
124             return null;
125         }
126         $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
127         return $avatar ? $avatar->url : null;
128     }
129 }
130