gnu-social/actions/apiusershow.php

126 lines
3.6 KiB
PHP
Raw Normal View History

2009-10-02 18:31:13 +01:00
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Show a user's profile information
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category API
* @package StatusNet
2009-10-13 00:36:00 +01:00
* @author Dan Moore <dan@moore.cx>
* @author Evan Prodromou <evan@status.net>
* @author mac65 <mac65@mac65.com>
2009-10-02 18:31:13 +01:00
* @author Zach Copley <zach@status.net>
* @copyright 2009 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('STATUSNET')) {
exit(1);
}
/**
* Ouputs information for a user, specified by ID or screen name.
* The user's most recent status will be returned inline.
*
* @category API
* @package StatusNet
2009-10-13 00:36:00 +01:00
* @author Dan Moore <dan@moore.cx>
* @author Evan Prodromou <evan@status.net>
* @author mac65 <mac65@mac65.com>
2009-10-02 18:31:13 +01:00
* @author Zach Copley <zach@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
class ApiUserShowAction extends ApiPrivateAuthAction
2009-10-02 18:31:13 +01:00
{
/**
* Take arguments for running
*
* @param array $args $_REQUEST args
*
* @return boolean success flag
*
*/
protected function prepare($args)
2009-10-02 18:31:13 +01:00
{
parent::prepare($args);
$email = $this->arg('email');
// XXX: email field deprecated in Twitter's API
if (!empty($email)) {
$user = User::getKV('email', $email);
2009-10-02 18:31:13 +01:00
} else {
$user = $this->getTargetUser($this->arg('id'));
2009-10-02 18:31:13 +01:00
}
if (!($user instanceof User)) {
// TRANS: Client error displayed when requesting user information for a non-existing user.
$this->clientError(_('User not found.'), 404);
}
$this->target = $user->getProfile();
2009-10-02 18:31:13 +01:00
return true;
}
/**
* Handle the request
*
* Check the format and show the user info
*
* @return void
*/
protected function handle()
2009-10-02 18:31:13 +01:00
{
parent::handle();
2009-10-02 18:31:13 +01:00
if (!in_array($this->format, array('xml', 'json'))) {
2011-04-03 23:12:52 +01:00
// TRANS: Client error displayed when coming across a non-supported API method.
$this->clientError(_('API method not found.'), 404);
2009-10-02 18:31:13 +01:00
}
$twitter_user = $this->twitterUserArray($this->target, true);
2009-10-02 18:31:13 +01:00
if ($this->format == 'xml') {
$this->initDocument('xml');
$this->showTwitterXmlUser($twitter_user, 'user', true);
$this->endDocument('xml');
2009-10-02 18:31:13 +01:00
} elseif ($this->format == 'json') {
$this->initDocument('json');
$this->showJsonObjects($twitter_user);
$this->endDocument('json');
2009-10-02 18:31:13 +01:00
}
}
/**
* Return true if read only.
*
* MAY override
*
* @param array $args other arguments
*
* @return boolean is read only action?
*/
function isReadOnly($args)
{
return true;
}
2009-10-02 18:31:13 +01:00
}