]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apiuserfollowers.php
Stronger typing and fixes in RequireValidatedEmail
[quix0rs-gnu-social.git] / actions / apiuserfollowers.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show a user's followers (subscribers)
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('GNUSOCIAL')) { exit(1); }
33
34 /**
35  * Ouputs the authenticating user's followers (subscribers), each with
36  * current Twitter-style status inline.  They are ordered by the order
37  * in which they subscribed to the user, 100 at a time.
38  *
39  * @category API
40  * @package  StatusNet
41  * @author   Dan Moore <dan@moore.cx>
42  * @author   Evan Prodromou <evan@status.net>
43  * @author   Zach Copley <zach@status.net>
44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45  * @link     http://status.net/
46  */
47 class ApiUserFollowersAction extends ApiSubscriptionsAction
48 {
49     /**
50      * Get the user's subscribers (followers) as an array of profiles
51      *
52      * @return array Profiles
53      */
54     protected function getProfiles()
55     {
56         $offset = ($this->page - 1) * $this->count;
57         $limit =  $this->count + 1;
58
59         $subs = null;
60
61         if (isset($this->tag)) {
62             $subs = $this->target->getTaggedSubscribers(
63                 $this->tag, $offset, $limit
64             );
65         } else {
66             $subs = $this->target->getSubscribers(
67                 $offset,
68                 $limit
69             );
70         }
71
72         $profiles = array();
73
74         while ($subs->fetch()) {
75             $profiles[] = clone($subs);
76         }
77
78         return $profiles;
79     }
80 }