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 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30 * @link http://status.net/
33 if (!defined('STATUSNET')) {
37 require_once INSTALLDIR . '/lib/apibareauth.php';
40 * Returns whether a user is a member of a specified group.
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/
52 class ApiGroupListAction extends ApiBareAuthAction
57 * Take arguments for running
59 * @param array $args $_REQUEST args
61 * @return boolean success flag
65 function prepare($args)
67 parent::prepare($args);
69 $this->user = $this->getTargetUser($id);
70 $this->groups = $this->getGroups();
78 * Show the user's groups
80 * @param array $args $_REQUEST data (unused)
85 function handle($args)
87 parent::handle($args);
89 if (empty($this->user)) {
90 $this->clientError(_('No such user.'), 404, $this->format);
94 $sitename = common_config('site', 'name');
95 $title = sprintf(_("%s's groups"), $this->user->nickname);
96 $taguribase = TagURI::base();
97 $id = "tag:$taguribase:Groups";
98 $link = common_local_url(
100 array('nickname' => $this->user->nickname)
103 _("Groups %1$s is a member of on %2$s."),
104 $this->user->nickname,
108 switch($this->format) {
110 $this->showXmlGroups($this->groups);
113 $this->showRssGroups($this->groups, $title, $link, $subtitle);
116 $selfuri = common_root_url() . 'api/statusnet/groups/list/' .
117 $this->user->id . '.atom';
118 $this->showAtomGroups(
128 $this->showJsonGroups($this->groups);
132 _('API method not found.'),
144 * @return array groups
151 $group = $this->user->getGroups(
152 ($this->page - 1) * $this->count,
158 while ($group->fetch()) {
159 $groups[] = clone($group);
166 * Is this action read only?
168 * @param array $args other arguments
170 * @return boolean true
173 function isReadOnly($args)
179 * When was this feed last modified?
181 * @return string datestamp of the latest group the user has joined
184 function lastModified()
186 if (!empty($this->groups) && (count($this->groups) > 0)) {
187 return strtotime($this->groups[0]->created);
194 * An entity tag for this list of groups
196 * Returns an Etag based on the action name, language, user ID and
197 * timestamps of the first and last group the user has joined
199 * @return string etag
204 if (!empty($this->groups) && (count($this->groups) > 0)) {
206 $last = count($this->groups) - 1;
208 return '"' . implode(
210 array($this->arg('action'),
213 strtotime($this->groups[0]->created),
214 strtotime($this->groups[$last]->created))