actions/apihelptest.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Test that you can connect to the API
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
  35  *
  36  * @category API
  37  * @package  StatusNet
  38  * @author   Evan Prodromou <evan@status.net>
  39  * @author   Zach Copley <zach@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43 class ApiHelpTestAction extends ApiPrivateAuthAction
  44 {
  45     protected function handle()
  46     {
  47         parent::handle();
  48
  49         if ($this->format == 'xml') {
  50             $this->initDocument('xml');
  51             $this->element('ok', null, 'true');
  52             $this->endDocument('xml');
  53         } elseif ($this->format == 'json') {
  54             $this->initDocument('json');
  55             print '"ok"';
  56             $this->endDocument('json');
  57         } else {
  58             // TRANS: Client error displayed when coming across a non-supported API method.
  59             throw new ClientException(_('API method not found.'), 404);
  60         }
  61     }
  62
  63     /**
  64      * Return true if read only.
  65      *
  66      * MAY override
  67      *
  68      * @param array $args other arguments
  69      *
  70      * @return boolean is read only action?
  71      */
  72     function isReadOnly($args)
  73     {
  74         return true;
  75     }
  76 }