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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  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 require_once INSTALLDIR . '/lib/apibareauth.php';
  35
  36 /**
  37  * Returns whether a user is a member of a specified group.
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  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  */
  45
  46 class ApiGroupIsMemberAction extends ApiBareAuthAction
  47 {
  48     var $user    = null;
  49     var $group   = null;
  50
  51     /**
  52      * Take arguments for running
  53      *
  54      * @param array $args $_REQUEST args
  55      *
  56      * @return boolean success flag
  57      *
  58      */
  59
  60     function prepare($args)
  61     {
  62         parent::prepare($args);
  63
  64         $this->user   = $this->getTargetUser(null);
  65         $this->group  = $this->getTargetGroup(null);
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Handle the request
  72      *
  73      * Save the new message
  74      *
  75      * @param array $args $_REQUEST data (unused)
  76      *
  77      * @return void
  78      */
  79
  80     function handle($args)
  81     {
  82         parent::handle($args);
  83
  84         if (empty($this->user)) {
  85             $this->clientError(_('No such user!'), 404, $this->format);
  86             return;
  87         }
  88
  89         if (empty($this->group)) {
  90             $this->clientError('Group not found!', 404, $this->format);
  91             return false;
  92         }
  93
  94         $is_member = $this->user->isMember($this->group);
  95
  96         switch($this->format) {
  97         case 'xml':
  98             $this->init_document('xml');
  99             $this->element('is_member', null, $is_member);
 100             $this->end_document('xml');
 101             break;
 102         case 'json':
 103             $this->init_document('json');
 104             $this->show_json_objects(array('is_member' => $is_member));
 105             $this->end_document('json');
 106             break;
 107         default:
 108             $this->clientError(
 109                 _('API method not found!'),
 110                 400,
 111                 $this->format
 112             );
 113             break;
 114         }
 115     }
 116
 117 }