actions/apilistsubscriptions.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Get a list of lists a user is subscribed to.
   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  * @copyright 2009 StatusNet, Inc.
  25  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 class ApiListSubscriptionsAction extends ApiBareAuthAction
  35 {
  36     var $lists = array();
  37     var $cursor = -1;
  38     var $next_cursor = 0;
  39     var $prev_cursor = 0;
  40
  41     /**
  42      * Take arguments for running
  43      *
  44      * @param array $args $_REQUEST args
  45      *
  46      * @return boolean success flag
  47      *
  48      */
  49     protected function prepare(array $args=array())
  50     {
  51         parent::prepare($args);
  52
  53         $this->cursor = (int) $this->arg('cursor', -1);
  54         $user = $this->getTargetUser($this->arg('user'));
  55         if (!($user instanceof User)) {
  56             // TRANS: Client error displayed trying to perform an action related to a non-existing user.
  57             $this->clientError(_('No such user.'), 404);
  58         }
  59         $this->target = $user->getProfile();
  60         $this->getLists();
  61
  62         return true;
  63     }
  64
  65     /**
  66      * Handle the request
  67      *
  68      * Show the lists
  69      *
  70      * @return void
  71      */
  72     protected function handle()
  73     {
  74         parent::handle();
  75
  76         switch($this->format) {
  77         case 'xml':
  78             $this->showXmlLists($this->lists, $this->next_cursor, $this->prev_cursor);
  79             break;
  80         case 'json':
  81             $this->showJsonLists($this->lists, $this->next_cursor, $this->prev_cursor);
  82             break;
  83         default:
  84             // TRANS: Client error displayed when coming across a non-supported API method.
  85             $this->clientError(_('API method not found.'));
  86         }
  87     }
  88
  89     /**
  90      * Return true if read only.
  91      *
  92      * MAY override
  93      *
  94      * @param array $args other arguments
  95      *
  96      * @return boolean is read only action?
  97      */
  98     function isReadOnly($args)
  99     {
 100         return true;
 101     }
 102
 103     function getLists()
 104     {
 105         $fn = array($this->target, 'getTagSubscriptions');
 106         # 20 lists
 107         list($this->lists, $this->next_cursor, $this->prev_cursor) =
 108                 Profile_list::getAtCursor($fn, array(), $this->cursor, 20);
 109     }
 110 }