]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apigroupismember.php
Localisation updates from translatewiki.net
[quix0rs-gnu-social.git] / 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  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30  * @link      http://status.net/
31  */
32
33 if (!defined('STATUSNET')) {
34     exit(1);
35 }
36
37 require_once INSTALLDIR . '/lib/apibareauth.php';
38
39 /**
40  * Returns whether a user is a member of a specified group.
41  *
42  * @category API
43  * @package  StatusNet
44  * @author   Craig Andrews <candrews@integralblue.com>
45  * @author   Evan Prodromou <evan@status.net>
46  * @author   Jeffery To <jeffery.to@gmail.com>
47  * @author   Zach Copley <zach@status.net>
48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
49  * @link     http://status.net/
50  */
51
52 class ApiGroupIsMemberAction extends ApiBareAuthAction
53 {
54     var $group   = null;
55
56     /**
57      * Take arguments for running
58      *
59      * @param array $args $_REQUEST args
60      *
61      * @return boolean success flag
62      *
63      */
64
65     function prepare($args)
66     {
67         parent::prepare($args);
68
69         $this->user   = $this->getTargetUser(null);
70         $this->group  = $this->getTargetGroup(null);
71
72         return true;
73     }
74
75     /**
76      * Handle the request
77      *
78      * Save the new message
79      *
80      * @param array $args $_REQUEST data (unused)
81      *
82      * @return void
83      */
84
85     function handle($args)
86     {
87         parent::handle($args);
88
89         if (empty($this->user)) {
90             $this->clientError(_('No such user!'), 404, $this->format);
91             return;
92         }
93
94         if (empty($this->group)) {
95             $this->clientError('Group not found!', 404, $this->format);
96             return false;
97         }
98
99         $is_member = $this->user->isMember($this->group);
100
101         switch($this->format) {
102         case 'xml':
103             $this->initDocument('xml');
104             $this->element('is_member', null, $is_member);
105             $this->endDocument('xml');
106             break;
107         case 'json':
108             $this->initDocument('json');
109             $this->showJsonObjects(array('is_member' => $is_member));
110             $this->endDocument('json');
111             break;
112         default:
113             $this->clientError(
114                 _('API method not found!'),
115                 400,
116                 $this->format
117             );
118             break;
119         }
120     }
121
122 }