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('STATUSNET')) {
  33     exit(1);
  34 }
  35
  36 require_once INSTALLDIR . '/lib/apibareauth.php';
  37
  38 /**
  39  * Ouputs the authenticating user's followers (subscribers), each with
  40  * current Twitter-style status inline.  They are ordered by the order
  41  * in which they subscribed to the user, 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
  52 class ApiUserFollowersAction extends ApiSubscriptionsAction
  53 {
  54     /**
  55      * Get the user's subscribers (followers) as an array of profiles
  56      *
  57      * @return array Profiles
  58      */
  59
  60     function getProfiles()
  61     {
  62         $offset = ($this->page - 1) * $this->count;
  63         $limit =  $this->count + 1;
  64
  65         $subs = null;
  66
  67         if (isset($this->tag)) {
  68             $subs = $this->user->getTaggedSubscribers(
  69                 $this->tag, $offset, $limit
  70             );
  71         } else {
  72             $subs = $this->user->getSubscribers(
  73                 $offset,
  74                 $limit
  75             );
  76         }
  77
  78         $profiles = array();
  79
  80         if (!empty($subs)) {
  81             while ($subs->fetch()) {
  82                 $profiles[] = clone($subs);
  83             }
  84         }
  85
  86         return $profiles;
  87     }
  88
  89 }