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 class ApiHelpTestAction extends ApiPrivateAuthAction
  48 {
  49     /**
  50      * Take arguments for running
  51      *
  52      * @param array $args $_REQUEST args
  53      *
  54      * @return boolean success flag
  55      */
  56     function prepare($args)
  57     {
  58         parent::prepare($args);
  59         return true;
  60     }
  61
  62     /**
  63      * Handle the request
  64      *
  65      * @param array $args $_REQUEST data (unused)
  66      *
  67      * @return void
  68      */
  69     function handle($args)
  70     {
  71         parent::handle($args);
  72
  73         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         } else {
  82             $this->clientError(
  83                 // TRANS: Client error displayed trying to execute an unknown API method testing API connectivity.
  84                 _('API method not found.'),
  85                 404,
  86                 $this->format
  87             );
  88         }
  89     }
  90
  91     /**
  92      * Return true if read only.
  93      *
  94      * MAY override
  95      *
  96      * @param array $args other arguments
  97      *
  98      * @return boolean is read only action?
  99      */
 100     function isReadOnly($args)
 101     {
 102         return true;
 103     }
 104 }