]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apiuserfriends.php
Subscription "get by" functions now don't use ArrayWrappers
[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 /**
37  * Ouputs the authenticating user's friends (subscriptions), each with
38  * current Twitter-style status inline.  They are ordered by the date
39  * in which the user subscribed to them, 100 at a time.
40  *
41  * @category API
42  * @package  StatusNet
43  * @author   Dan Moore <dan@moore.cx>
44  * @author   Evan Prodromou <evan@status.net>
45  * @author   Zach Copley <zach@status.net>
46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47  * @link     http://status.net/
48  */
49 class ApiUserFriendsAction extends ApiSubscriptionsAction
50 {
51     /**
52      * Get the user's subscriptions (friends) as an array of profiles
53      *
54      * @return array Profiles
55      */
56     function getProfiles()
57     {
58         $offset = ($this->page - 1) * $this->count;
59         $limit =  $this->count + 1;
60
61         $subs = null;
62
63         if (isset($this->tag)) {
64             $subs = $this->user->getTaggedSubscriptions(
65                 $this->tag, $offset, $limit
66             );
67         } else {
68             $subs = $this->user->getSubscribed(
69                 $offset,
70                 $limit
71             );
72         }
73
74         $profiles = array();
75
76         if (!empty($subs)) {
77             while ($subs->fetch()) {
78                 $profiles[] = clone($subs);
79             }
80         }
81
82         return $profiles;
83     }
84 }