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 require_once INSTALLDIR . '/lib/apibareauth.php';
  34
  35 /**
  36  * Action handler for API method to list lists a user belongs to.
  37  * (people tags for a user)
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Shashi Gowda <connect2shashi@gmail.com>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  * @see      ApiBareAuthAction
  45  */
  46
  47 class ApiListMembershipsAction extends ApiBareAuthAction
  48 {
  49     var $lists = array();
  50     var $cursor = -1;
  51     var $next_cursor = 0;
  52     var $prev_cursor = 0;
  53
  54     /**
  55      * Prepare for running the action
  56      * Take arguments for running:s
  57      *
  58      * @param array $args $_REQUEST args
  59      *
  60      * @return boolean success flag
  61      *
  62      */
  63
  64     function prepare($args)
  65     {
  66         parent::prepare($args);
  67
  68         $this->cursor = (int) $this->arg('cursor', -1);
  69         $this->user = $this->getTargetUser($this->arg('user'));
  70
  71         if (empty($this->user)) {
  72             $this->clientError(_('No such user.'), 404, $this->format);
  73             return;
  74         }
  75
  76         $this->getLists();
  77
  78         return true;
  79     }
  80
  81     /**
  82      * Handle the request
  83      *
  84      * Show the lists
  85      *
  86      * @param array $args $_REQUEST data (unused)
  87      *
  88      * @return void
  89      */
  90
  91     function handle($args)
  92     {
  93         parent::handle($args);
  94
  95         switch($this->format) {
  96         case 'xml':
  97             $this->showXmlLists($this->lists, $this->next_cursor, $this->prev_cursor);
  98             break;
  99         case 'json':
 100             $this->showJsonLists($this->lists, $this->next_cursor, $this->prev_cursor);
 101             break;
 102         default:
 103             $this->clientError(
 104                 _('API method not found.'),
 105                 400,
 106                 $this->format
 107             );
 108             break;
 109         }
 110     }
 111
 112     /**
 113      * Return true if read only.
 114      *
 115      * MAY override
 116      *
 117      * @param array $args other arguments
 118      *
 119      * @return boolean is read only action?
 120      */
 121
 122     function isReadOnly($args)
 123     {
 124         return true;
 125     }
 126
 127     function getLists()
 128     {
 129         $profile = $this->user->getProfile();
 130         $fn = array($profile, 'getOtherTags');
 131
 132         # 20 lists
 133         list($this->lists, $this->next_cursor, $this->prev_cursor) =
 134                 Profile_list::getAtCursor($fn, array($this->auth_user), $this->cursor, 20);
 135     }
 136 }