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(null);
71 if (empty($this->user)) {
72 $this->clientError(_('No such user.'), 404, $this->format);
76 $this->groups = $this->getGroups();
84 * Show the user's groups
86 * @param array $args $_REQUEST data (unused)
91 function handle($args)
93 parent::handle($args);
95 $sitename = common_config('site', 'name');
96 $title = sprintf(_("%s's groups"), $this->user->nickname);
97 $taguribase = TagURI::base();
98 $id = "tag:$taguribase:Groups";
99 $link = common_local_url(
101 array('nickname' => $this->user->nickname)
104 _("Groups %1\$s is a member of on %2\$s."),
105 $this->user->nickname,
109 switch($this->format) {
111 $this->showXmlGroups($this->groups);
114 $this->showRssGroups($this->groups, $title, $link, $subtitle);
117 $selfuri = common_root_url() . 'api/statusnet/groups/list/' .
118 $this->user->id . '.atom';
119 $this->showAtomGroups(
129 $this->showJsonGroups($this->groups);
133 _('API method not found.'),
145 * @return array groups
152 $group = $this->user->getGroups(
153 ($this->page - 1) * $this->count,
159 while ($group->fetch()) {
160 $groups[] = clone($group);
167 * Is this action read only?
169 * @param array $args other arguments
171 * @return boolean true
174 function isReadOnly($args)
180 * When was this feed last modified?
182 * @return string datestamp of the latest group the user has joined
185 function lastModified()
187 if (!empty($this->groups) && (count($this->groups) > 0)) {
188 return strtotime($this->groups[0]->created);
195 * An entity tag for this list of groups
197 * Returns an Etag based on the action name, language, user ID and
198 * timestamps of the first and last group the user has joined
200 * @return string etag
205 if (!empty($this->groups) && (count($this->groups) > 0)) {
207 $last = count($this->groups) - 1;
209 return '"' . implode(
211 array($this->arg('action'),
214 strtotime($this->groups[0]->created),
215 strtotime($this->groups[$last]->created))