actions/apilistmemberships.php

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