actions/apigroupismember.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Check to see whether a user a member of a group
   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    Craig Andrews <candrews@integralblue.com>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Jeffery To <jeffery.to@gmail.com>
  27  * @author    Zach Copley <zach@status.net>
  28  * @copyright 2009 StatusNet, Inc.
  29  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  30  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  31  * @link      http://status.net/
  32  */
  33
  34 if (!defined('STATUSNET')) {
  35     exit(1);
  36 }
  37
  38 /**
  39  * Returns whether a user is a member of a specified group.
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Craig Andrews <candrews@integralblue.com>
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   Jeffery To <jeffery.to@gmail.com>
  46  * @author   Zach Copley <zach@status.net>
  47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  48  * @link     http://status.net/
  49  */
  50 class ApiGroupIsMemberAction extends ApiBareAuthAction
  51 {
  52     var $group   = null;
  53
  54     /**
  55      * Take arguments for running
  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->user   = $this->getTargetUser(null);
  67         $this->group  = $this->getTargetGroup(null);
  68
  69         return true;
  70     }
  71
  72     /**
  73      * Handle the request
  74      *
  75      * Save the new message
  76      *
  77      * @param array $args $_REQUEST data (unused)
  78      *
  79      * @return void
  80      */
  81     function handle($args)
  82     {
  83         parent::handle($args);
  84
  85         if (empty($this->user)) {
  86             // TRANS: Client error displayed when checking group membership for a non-existing user.
  87             $this->clientError(_('No such user.'), 404, $this->format);
  88             return;
  89         }
  90
  91         if (empty($this->group)) {
  92             // TRANS: Client error displayed when checking group membership for a non-existing group.
  93             $this->clientError(_('Group not found.'), 404, $this->format);
  94             return false;
  95         }
  96
  97         $is_member = $this->user->isMember($this->group);
  98
  99         switch($this->format) {
 100         case 'xml':
 101             $this->initDocument('xml');
 102             $this->element('is_member', null, $is_member);
 103             $this->endDocument('xml');
 104             break;
 105         case 'json':
 106             $this->initDocument('json');
 107             $this->showJsonObjects(array('is_member' => $is_member));
 108             $this->endDocument('json');
 109             break;
 110         default:
 111             $this->clientError(
 112                 // TRANS: Client error displayed when coming across a non-supported API method.
 113                 _('API method not found.'),
 114                 400,
 115                 $this->format
 116             );
 117             break;
 118         }
 119     }
 120
 121     /**
 122      * Return true if read only.
 123      *
 124      * MAY override
 125      *
 126      * @param array $args other arguments
 127      *
 128      * @return boolean is read only action?
 129      */
 130     function isReadOnly($args)
 131     {
 132         return true;
 133     }
 134 }