3 * StatusNet, the distributed open-source microblogging tool
5 * Show a user's profile information
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 Dan Moore <dan@moore.cx>
25 * @author Evan Prodromou <evan@status.net>
26 * @author mac65 <mac65@mac65.com>
27 * @author Zach Copley <zach@status.net>
28 * @copyright 2009 StatusNet, Inc.
29 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30 * @link http://status.net/
33 if (!defined('STATUSNET')) {
37 require_once INSTALLDIR . '/lib/apiprivateauth.php';
40 * Ouputs information for a user, specified by ID or screen name.
41 * The user's most recent status will be returned inline.
45 * @author Dan Moore <dan@moore.cx>
46 * @author Evan Prodromou <evan@status.net>
47 * @author mac65 <mac65@mac65.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/
52 class ApiUserShowAction extends ApiPrivateAuthAction
55 * Take arguments for running
57 * @param array $args $_REQUEST args
59 * @return boolean success flag
62 function prepare($args)
64 parent::prepare($args);
66 $email = $this->arg('email');
68 // XXX: email field deprecated in Twitter's API
71 $this->user = User::staticGet('email', $email);
73 $this->user = $this->getTargetUser($this->arg('id'));
82 * Check the format and show the user info
84 * @param array $args $_REQUEST data (unused)
88 function handle($args)
90 parent::handle($args);
92 if (empty($this->user)) {
93 // TRANS: Client error displayed when requesting user information for a non-existing user.
94 $this->clientError(_('User not found.'), 404, $this->format);
98 if (!in_array($this->format, array('xml', 'json'))) {
99 // TRANS: Client error displayed when coming across a non-supported API method.
100 $this->clientError(_('API method not found.'), $code = 404);
104 $profile = $this->user->getProfile();
106 if (empty($profile)) {
107 // TRANS: Error message displayed when referring to a user without a profile.
108 $this->clientError(_('User has no profile.'));
112 $twitter_user = $this->twitterUserArray($this->user->getProfile(), true);
114 if ($this->format == 'xml') {
115 $this->initDocument('xml');
116 $this->showTwitterXmlUser($twitter_user, 'user', true);
117 $this->endDocument('xml');
118 } elseif ($this->format == 'json') {
119 $this->initDocument('json');
120 $this->showJsonObjects($twitter_user);
121 $this->endDocument('json');
126 * Return true if read only.
130 * @param array $args other arguments
132 * @return boolean is read only action?
134 function isReadOnly($args)