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 class ApiListMembershipsAction extends ApiBareAuthAction
  47 {
  48     var $lists = array();
  49     var $cursor = -1;
  50     var $next_cursor = 0;
  51     var $prev_cursor = 0;
  52
  53     /**
  54      * Prepare for running the action
  55      * Take arguments for running:s
  56      *
  57      * @param array $args $_REQUEST args
  58      *
  59      * @return boolean success flag
  60      *
  61      */
  62     function prepare($args)
  63     {
  64         parent::prepare($args);
  65
  66         $this->cursor = (int) $this->arg('cursor', -1);
  67         $this->user = $this->getTargetUser($this->arg('user'));
  68
  69         if (empty($this->user)) {
  70             // TRANS: Client error displayed trying to perform an action related to a non-existing user.
  71             $this->clientError(_('No such user.'), 404, $this->format);
  72             return;
  73         }
  74
  75         $this->getLists();
  76
  77         return true;
  78     }
  79
  80     /**
  81      * Handle the request
  82      *
  83      * Show the lists
  84      *
  85      * @param array $args $_REQUEST data (unused)
  86      *
  87      * @return void
  88      */
  89     function handle($args)
  90     {
  91         parent::handle($args);
  92
  93         switch($this->format) {
  94         case 'xml':
  95             $this->showXmlLists($this->lists, $this->next_cursor, $this->prev_cursor);
  96             break;
  97         case 'json':
  98             $this->showJsonLists($this->lists, $this->next_cursor, $this->prev_cursor);
  99             break;
 100         default:
 101             $this->clientError(
 102                 // TRANS: Client error displayed when coming across a non-supported API method.
 103                 _('API method not found.'),
 104                 400,
 105                 $this->format
 106             );
 107             break;
 108         }
 109     }
 110
 111     /**
 112      * Return true if read only.
 113      *
 114      * MAY override
 115      *
 116      * @param array $args other arguments
 117      *
 118      * @return boolean is read only action?
 119      */
 120     function isReadOnly($args)
 121     {
 122         return true;
 123     }
 124
 125     function getLists()
 126     {
 127         $profile = $this->user->getProfile();
 128         $fn = array($profile, 'getOtherTags');
 129
 130         # 20 lists
 131         list($this->lists, $this->next_cursor, $this->prev_cursor) =
 132                 Profile_list::getAtCursor($fn, array($this->auth_user), $this->cursor, 20);
 133     }
 134 }