]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apiuserfriends.php
Give NoticeListItem its own class
[quix0rs-gnu-social.git] / actions / apiuserfriends.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show a user's friends (subscriptions)
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  API
23  * @package   StatusNet
24  * @author    Dan Moore <dan@moore.cx>
25  * @author    Evan Prodromou <evan@status.net>
26  * @author    Zach Copley <zach@status.net>
27  * @copyright 2009 StatusNet, Inc.
28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29  * @link      http://status.net/
30  */
31
32 if (!defined('STATUSNET')) {
33     exit(1);
34 }
35
36 require_once INSTALLDIR . '/lib/apibareauth.php';
37
38 /**
39  * Ouputs the authenticating user's friends (subscriptions), each with
40  * current Twitter-style status inline.  They are ordered by the date
41  * in which the user subscribed to them, 100 at a time.
42  *
43  * @category API
44  * @package  StatusNet
45  * @author   Dan Moore <dan@moore.cx>
46  * @author   Evan Prodromou <evan@status.net>
47  * @author   Zach Copley <zach@status.net>
48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
49  * @link     http://status.net/
50  */
51 class ApiUserFriendsAction extends ApiSubscriptionsAction
52 {
53     /**
54      * Get the user's subscriptions (friends) as an array of profiles
55      *
56      * @return array Profiles
57      */
58     function getProfiles()
59     {
60         $offset = ($this->page - 1) * $this->count;
61         $limit =  $this->count + 1;
62
63         $subs = null;
64
65         if (isset($this->tag)) {
66             $subs = $this->user->getTaggedSubscriptions(
67                 $this->tag, $offset, $limit
68             );
69         } else {
70             $subs = $this->user->getSubscriptions(
71                 $offset,
72                 $limit
73             );
74         }
75
76         $profiles = array();
77
78         if (!empty($subs)) {
79             while ($subs->fetch()) {
80                 $profiles[] = clone($subs);
81             }
82         }
83
84         return $profiles;
85     }
86 }