]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apigroupmembership.php
Profile/Peopletag file splitting for autoload
[quix0rs-gnu-social.git] / actions / apigroupmembership.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * List a group's members
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  API
23  * @package   StatusNet
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/
32  */
33
34 if (!defined('STATUSNET')) {
35     exit(1);
36 }
37
38 /**
39  * List 20 newest members of the group specified by name or ID.
40  *
41  * @category API
42  * @package  StatusNet
43  * @author   Craig Andrews <candrews@integralblue.com>
44  * @author   Evan Prodromou <evan@status.net>
45  * @author   Jeffery To <jeffery.to@gmail.com>
46  * @author   Zach Copley <zach@status.net>
47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48  * @link     http://status.net/
49  */
50 class ApiGroupMembershipAction extends ApiPrivateAuthAction
51 {
52     var $group    = null;
53     var $profiles = null;
54
55     /**
56      * Take arguments for running
57      *
58      * @param array $args $_REQUEST args
59      *
60      * @return boolean success flag
61      */
62     protected function prepare(array $args=array())
63     {
64         parent::prepare($args);
65
66         $this->group    = $this->getTargetGroup($this->arg('id'));
67         if (empty($this->group)) {
68             // TRANS: Client error displayed trying to show group membership on a non-existing group.
69             $this->clientError(_('Group not found.'), 404);
70         }
71
72         $this->profiles = $this->getProfiles();
73
74         return true;
75     }
76
77     /**
78      * Handle the request
79      *
80      * Show the members of the group
81      *
82      * @return void
83      */
84     protected function handle()
85     {
86         parent::handle();
87
88         // XXX: RSS and Atom
89
90         switch($this->format) {
91         case 'xml':
92             $this->showTwitterXmlUsers($this->profiles);
93             break;
94         case 'json':
95             $this->showJsonUsers($this->profiles);
96             break;
97         default:
98             // TRANS: Client error displayed when coming across a non-supported API method.
99             $this->clientError(_('API method not found.'), 404);
100         }
101     }
102
103     /**
104      * Fetch the members of a group
105      *
106      * @return array $profiles list of profiles
107      */
108     function getProfiles()
109     {
110         $profiles = array();
111
112         $profile = $this->group->getMembers(
113             ($this->page - 1) * $this->count,
114             $this->count,
115             $this->since_id,
116             $this->max_id
117         );
118
119         while ($profile->fetch()) {
120             $profiles[] = clone($profile);
121         }
122
123         return $profiles;
124     }
125
126     /**
127      * Is this action read only?
128      *
129      * @param array $args other arguments
130      *
131      * @return boolean true
132      */
133     function isReadOnly($args)
134     {
135         return true;
136     }
137
138     /**
139      * When was this list of profiles last modified?
140      *
141      * @return string datestamp of the lastest profile in the group
142      */
143     function lastModified()
144     {
145         if (!empty($this->profiles) && (count($this->profiles) > 0)) {
146             return strtotime($this->profiles[0]->created);
147         }
148
149         return null;
150     }
151
152     /**
153      * An entity tag for this list of groups
154      *
155      * Returns an Etag based on the action name, language
156      * the group id, and timestamps of the first and last
157      * user who has joined the group
158      *
159      * @return string etag
160      */
161     function etag()
162     {
163         if (!empty($this->profiles) && (count($this->profiles) > 0)) {
164
165             $last = count($this->profiles) - 1;
166
167             return '"' . implode(
168                 ':',
169                 array($this->arg('action'),
170                       common_user_cache_hash($this->auth_user),
171                       common_language(),
172                       $this->group->id,
173                       strtotime($this->profiles[0]->created),
174                       strtotime($this->profiles[$last]->created))
175             )
176             . '"';
177         }
178
179         return null;
180     }
181 }