]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apihelptest.php
updateWithKeys reworked to more reliable execution
[quix0rs-gnu-social.git] / 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 /**
36  * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
37  *
38  * @category API
39  * @package  StatusNet
40  * @author   Evan Prodromou <evan@status.net>
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 class ApiHelpTestAction extends ApiPrivateAuthAction
46 {
47     /**
48      * Take arguments for running
49      *
50      * @param array $args $_REQUEST args
51      *
52      * @return boolean success flag
53      */
54     function prepare($args)
55     {
56         parent::prepare($args);
57         return true;
58     }
59
60     /**
61      * Handle the request
62      *
63      * @param array $args $_REQUEST data (unused)
64      *
65      * @return void
66      */
67     function handle($args)
68     {
69         parent::handle($args);
70
71         if ($this->format == 'xml') {
72             $this->initDocument('xml');
73             $this->element('ok', null, 'true');
74             $this->endDocument('xml');
75         } elseif ($this->format == 'json') {
76             $this->initDocument('json');
77             print '"ok"';
78             $this->endDocument('json');
79         } else {
80             $this->clientError(
81                 // TRANS: Client error displayed when coming across a non-supported API method.
82                 _('API method not found.'),
83                 404,
84                 $this->format
85             );
86         }
87     }
88
89     /**
90      * Return true if read only.
91      *
92      * MAY override
93      *
94      * @param array $args other arguments
95      *
96      * @return boolean is read only action?
97      */
98     function isReadOnly($args)
99     {
100         return true;
101     }
102 }