3 * StatusNet, the distributed open-source microblogging tool
5 * Get a list of lists a user is subscribed to.
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 * @copyright 2009 StatusNet, Inc.
25 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
34 class ApiListSubscriptionsAction extends ApiBareAuthAction
42 * Take arguments for running
44 * @param array $args $_REQUEST args
46 * @return boolean success flag
49 protected function prepare(array $args=array())
51 parent::prepare($args);
53 $this->cursor = (int) $this->arg('cursor', -1);
54 $user = $this->getTargetUser($this->arg('user'));
55 if (!($user instanceof User)) {
56 // TRANS: Client error displayed trying to perform an action related to a non-existing user.
57 $this->clientError(_('No such user.'), 404);
59 $this->target = $user->getProfile();
72 protected function handle()
76 switch($this->format) {
78 $this->showXmlLists($this->lists, $this->next_cursor, $this->prev_cursor);
81 $this->showJsonLists($this->lists, $this->next_cursor, $this->prev_cursor);
84 // TRANS: Client error displayed when coming across a non-supported API method.
85 $this->clientError(_('API method not found.'));
90 * Return true if read only.
94 * @param array $args other arguments
96 * @return boolean is read only action?
98 function isReadOnly(array $args=array())
105 $fn = array($this->target, 'getTagSubscriptions');
107 list($this->lists, $this->next_cursor, $this->prev_cursor) =
108 Profile_list::getAtCursor($fn, array(), $this->cursor, 20);