3 * StatusNet, the distributed open-source microblogging tool
5 * Check to see whether a user a member of a group
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.
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.
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/>.
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/
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR . '/lib/apibareauth.php';
37 * Returns whether a user is a member of a specified group.
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/
46 class ApiGroupIsMemberAction extends ApiBareAuthAction
53 * Take arguments for running
55 * @param array $args $_REQUEST args
57 * @return boolean success flag
61 function prepare($args)
63 parent::prepare($args);
65 if ($this->requiresAuth()) {
66 if ($this->checkBasicAuthUser() == false) {
71 $this->user = $this->getTargetUser(null);
72 $this->group = $this->getTargetGroup(null);
73 $this->format = $this->arg('format');
81 * Save the new message
83 * @param array $args $_REQUEST data (unused)
88 function handle($args)
90 parent::handle($args);
92 if (empty($this->user)) {
93 $this->clientError(_('No such user!'), 404, $this->format);
97 if (empty($this->group)) {
98 $this->clientError('Group not found!', 404, $this->format);
102 $is_member = $this->user->isMember($this->group);
104 switch($this->format) {
106 $this->init_document('xml');
107 $this->element('is_member', null, $is_member);
108 $this->end_document('xml');
111 $this->init_document('json');
112 $this->show_json_objects(array('is_member' => $is_member));
113 $this->end_document('json');
117 _('API method not found!'),