3 * StatusNet, the distributed open-source microblogging tool
5 * Show information about 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')) {
38 require_once INSTALLDIR . '/lib/apiprivateauth.php';
41 * Outputs detailed information about the group specified by 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 * @author Michele <macno@macno.org>
50 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
51 * @link http://status.net/
54 class ApiGroupShowAction 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'));
73 if (empty($this->group)) {
74 $alias = Group_alias::staticGet(
76 common_canonical_nickname($this->arg('id'))
79 $args = array('id' => $alias->group_id, 'format' => $this->format);
80 common_redirect(common_local_url('ApiGroupShow', $args), 301);
83 _('Group not found.'),
97 * Check the format and show the user info
99 * @param array $args $_REQUEST data (unused)
104 function handle($args)
106 parent::handle($args);
108 switch($this->format) {
110 $this->showSingleXmlGroup($this->group);
113 $this->showSingleJsonGroup($this->group);
116 $this->clientError(_('API method not found.'), 404, $this->format);
122 * When was this group last modified?
124 * @return string datestamp of the latest notice in the stream
127 function lastModified()
129 if (!empty($this->group)) {
130 return strtotime($this->group->modified);
137 * An entity tag for this group
139 * Returns an Etag based on the action name, language, and
140 * timestamps of the notice
142 * @return string etag
147 if (!empty($this->group)) {
149 return '"' . implode(
151 array($this->arg('action'),
154 strtotime($this->group->modified))
163 * Return true if read only.
167 * @param array $args other arguments
169 * @return boolean is read only action?
172 function isReadOnly($args)