gnu-social/actions/apihelptest.php

77 lines
2.4 KiB
PHP
Raw Normal View History

2009-10-08 23:59:00 +01:00
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Test that you can connect to the API
*
* 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 Evan Prodromou <evan@status.net>
2009-10-08 23:59:00 +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/
*/
2016-04-18 14:21:05 +01:00
if (!defined('GNUSOCIAL')) { exit(1); }
2009-10-08 23:59:00 +01:00
/**
* Returns the string "ok" in the requested format with a 200 OK HTTP status code.
*
* @category API
* @package StatusNet
2009-10-13 00:36:00 +01:00
* @author Evan Prodromou <evan@status.net>
2009-10-08 23:59:00 +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 ApiHelpTestAction extends ApiPrivateAuthAction
2009-10-08 23:59:00 +01:00
{
2016-04-18 14:21:05 +01:00
protected function handle()
2009-10-08 23:59:00 +01:00
{
2016-04-18 14:21:05 +01:00
parent::handle();
2009-10-08 23:59:00 +01:00
if ($this->format == 'xml') {
$this->initDocument('xml');
2009-10-08 23:59:00 +01:00
$this->element('ok', null, 'true');
$this->endDocument('xml');
2009-10-08 23:59:00 +01:00
} elseif ($this->format == 'json') {
$this->initDocument('json');
2009-10-08 23:59:00 +01:00
print '"ok"';
$this->endDocument('json');
2009-10-08 23:59:00 +01:00
} else {
2016-04-18 14:21:05 +01:00
// TRANS: Client error displayed when coming across a non-supported API method.
throw new ClientException(_('API method not found.'), 404);
2009-10-08 23:59:00 +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-08 23:59:00 +01:00
}