apihelptest.php 2.84 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
<?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
Zach Copley's avatar
Zach Copley committed
24
 * @author    Evan Prodromou <evan@status.net>
25 26 27 28 29 30 31 32 33 34
 * @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);
}

35
require_once INSTALLDIR . '/lib/apiprivateauth.php';
36 37 38 39 40 41

/**
 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
42
 * @author   Evan Prodromou <evan@status.net>
43 44 45 46
 * @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/
 */
47
class ApiHelpTestAction extends ApiPrivateAuthAction
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
{
    /**
     * 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') {
74
            $this->initDocument('xml');
75
            $this->element('ok', null, 'true');
76
            $this->endDocument('xml');
77
        } elseif ($this->format == 'json') {
78
            $this->initDocument('json');
79
            print '"ok"';
80
            $this->endDocument('json');
81 82
        } else {
            $this->clientError(
83
                // TRANS: Client error displayed when coming across a non-supported API method.
84
                _('API method not found.'),
85 86 87 88 89 90
                404,
                $this->format
            );
        }
    }

91 92 93 94 95 96 97 98 99 100 101 102 103
    /**
     * Return true if read only.
     *
     * MAY override
     *
     * @param array $args other arguments
     *
     * @return boolean is read only action?
     */
    function isReadOnly($args)
    {
        return true;
    }
104
}