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