We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

apihelptest.php 2.41 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
<?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
 * @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);
}

34
require_once INSTALLDIR . '/lib/api.php';
35 36 37 38 39 40 41 42 43 44 45

/**
 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
 *
 * @category API
 * @package  StatusNet
 * @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/
 */

46
class ApiHelpTestAction extends ApiAction
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
{

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     *
     */

    function prepare($args)
    {
        parent::prepare($args);
        return true;
    }

    /**
     * Handle the request
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */

    function handle($args)
    {
        parent::handle($args);

        if ($this->format == 'xml') {
77
            $this->initDocument('xml');
78
            $this->element('ok', null, 'true');
79
            $this->endDocument('xml');
80
        } elseif ($this->format == 'json') {
81
            $this->initDocument('json');
82
            print '"ok"';
83
            $this->endDocument('json');
84 85 86 87 88 89 90 91 92 93 94
        } else {
            $this->clientError(
                _('API method not found!'),
                404,
                $this->format
            );
        }
    }

}