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 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/
34 if (!defined('STATUSNET')) {
39 * Returns whether a user is a member of a specified group.
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/
50 class ApiGroupIsMemberAction extends ApiBareAuthAction
55 * Take arguments for running
57 * @param array $args $_REQUEST args
59 * @return boolean success flag
62 protected function prepare(array $args=array())
64 parent::prepare($args);
66 $this->target = $this->getTargetProfile(null);
67 $this->group = $this->getTargetGroup(null);
75 * Save the new message
79 protected function handle()
83 if (empty($this->target)) {
84 // TRANS: Client error displayed when checking group membership for a non-existing user.
85 $this->clientError(_('No such user.'), 404);
88 if (empty($this->group)) {
89 // TRANS: Client error displayed when checking group membership for a non-existing group.
90 $this->clientError(_('Group not found.'), 404);
93 $is_member = $this->target->isMember($this->group);
95 switch($this->format) {
97 $this->initDocument('xml');
98 $this->element('is_member', null, $is_member);
99 $this->endDocument('xml');
102 $this->initDocument('json');
103 $this->showJsonObjects(array('is_member' => $is_member));
104 $this->endDocument('json');
107 // TRANS: Client error displayed when coming across a non-supported API method.
108 $this->clientError(_('API method not found.'));
113 * Return true if read only.
117 * @param array $args other arguments
119 * @return boolean is read only action?
121 function isReadOnly(array $args=array())