3 * StatusNet, the distributed open-source microblogging tool
5 * List a group's members
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')) {
38 require_once INSTALLDIR . '/lib/apiprivateauth.php';
41 * List 20 newest members of the group specified by name or ID.
45 * @author Craig Andrews <candrews@integralblue.com>
46 * @author Evan Prodromou <evan@status.net>
47 * @author Jeffery To <jeffery.to@gmail.com>
48 * @author Zach Copley <zach@status.net>
49 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
50 * @link http://status.net/
53 class ApiGroupMembershipAction extends ApiPrivateAuthAction
59 * Take arguments for running
61 * @param array $args $_REQUEST args
63 * @return boolean success flag
67 function prepare($args)
69 parent::prepare($args);
71 $this->group = $this->getTargetGroup($this->arg('id'));
72 $this->profiles = $this->getProfiles();
80 * Show the members of the group
82 * @param array $args $_REQUEST data (unused)
87 function handle($args)
89 parent::handle($args);
91 if (empty($this->group)) {
92 $this->clientError(_('Group not found.'), 404, $this->format);
98 switch($this->format) {
100 $this->showTwitterXmlUsers($this->profiles);
103 $this->showJsonUsers($this->profiles);
107 _('API method not found.'),
116 * Fetch the members of a group
118 * @return array $profiles list of profiles
121 function getProfiles()
125 $profile = $this->group->getMembers(
126 ($this->page - 1) * $this->count,
132 while ($profile->fetch()) {
133 $profiles[] = clone($profile);
140 * Is this action read only?
142 * @param array $args other arguments
144 * @return boolean true
147 function isReadOnly($args)
153 * When was this list of profiles last modified?
155 * @return string datestamp of the lastest profile in the group
158 function lastModified()
160 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
161 return strtotime($this->profiles[0]->created);
168 * An entity tag for this list of groups
170 * Returns an Etag based on the action name, language
171 * the group id, and timestamps of the first and last
172 * user who has joined the group
174 * @return string etag
179 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
181 $last = count($this->profiles) - 1;
183 return '"' . implode(
185 array($this->arg('action'),
186 common_user_cache_hash($this->auth_user),
189 strtotime($this->profiles[0]->created),
190 strtotime($this->profiles[$last]->created))