3 * StatusNet, the distributed open-source microblogging tool
5 * List a group's admins
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 * @author Hannes Mannerheim <h@nnesmannerhe.im>
29 * @copyright 2009 StatusNet, Inc.
30 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
31 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
32 * @link http://www.gnu.org/software/social/
35 if (!defined('GNUSOCIAL')) {
40 * List 20 newest admins of the group specified by name or ID.
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 * @author Hannes Mannerheim <h@nnesmannerhe.im>
49 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
50 * @link http://www.gnu.org/software/social/
52 class ApiGroupAdminsAction extends ApiPrivateAuthAction
58 * Take arguments for running
60 * @param array $args $_REQUEST args
62 * @return boolean success flag
64 protected function prepare(array $args=array())
66 parent::prepare($args);
68 $this->group = $this->getTargetGroup($this->arg('id'));
69 if (empty($this->group)) {
70 // TRANS: Client error displayed trying to show group membership on a non-existing group.
71 $this->clientError(_('Group not found.'), 404);
74 $this->profiles = $this->getProfiles();
82 * Show the admin of the group
84 * @param array $args $_REQUEST data (unused)
88 protected function handle()
94 switch($this->format) {
96 $this->showTwitterXmlUsers($this->profiles);
99 $this->showJsonUsers($this->profiles);
103 // TRANS: Client error displayed when coming across a non-supported API method.
104 _('API method not found.'),
113 * Fetch the admins of a group
115 * @return array $profiles list of profiles
117 function getProfiles()
121 $profile = $this->group->getAdmins(
122 ($this->page - 1) * $this->count,
128 while ($profile->fetch()) {
129 $profiles[] = clone($profile);
136 * Is this action read only?
138 * @param array $args other arguments
140 * @return boolean true
142 function isReadOnly($args)
148 * When was this list of profiles last modified?
150 * @return string datestamp of the lastest profile in the group
152 function lastModified()
154 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
155 return strtotime($this->profiles[0]->created);
162 * An entity tag for this list of groups
164 * Returns an Etag based on the action name, language
165 * the group id, and timestamps of the first and last
166 * user who has joined the group
168 * @return string etag
172 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
174 $last = count($this->profiles) - 1;
176 return '"' . implode(
178 array($this->arg('action'),
179 common_user_cache_hash($this->auth_user),
182 strtotime($this->profiles[0]->created),
183 strtotime($this->profiles[$last]->created))