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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/api.php';
  35
  36 /**
  37  * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45
  46 class ApiHelpTestAction extends ApiAction
  47 {
  48
  49     /**
  50      * Take arguments for running
  51      *
  52      * @param array $args $_REQUEST args
  53      *
  54      * @return boolean success flag
  55      *
  56      */
  57
  58     function prepare($args)
  59     {
  60         parent::prepare($args);
  61         return true;
  62     }
  63
  64     /**
  65      * Handle the request
  66      *
  67      * @param array $args $_REQUEST data (unused)
  68      *
  69      * @return void
  70      */
  71
  72     function handle($args)
  73     {
  74         parent::handle($args);
  75
  76         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         } else {
  85             $this->clientError(
  86                 _('API method not found!'),
  87                 404,
  88                 $this->format
  89             );
  90         }
  91     }
  92
  93 }
  94