]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apistatusnetversion.php
Use array_merge instead of array_replace (same effect, and array_merge works with...
[quix0rs-gnu-social.git] / actions / apistatusnetversion.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * A version stamp for 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 a version number for this version of StatusNet, which
39  * should make things a bit easier for upgrades.
40  * URL: http://identi.ca/api/statusnet/version.(xml|json)
41  * Formats: xml, js
42  *
43  * @category API
44  * @package  StatusNet
45  * @author   Evan Prodromou <evan@status.net>
46  * @author   Zach Copley <zach@status.net>
47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48  * @link     http://status.net/
49  */
50 class ApiStatusnetVersionAction extends ApiPrivateAuthAction
51 {
52     /**
53      * Take arguments for running
54      *
55      * @param array $args $_REQUEST args
56      *
57      * @return boolean success flag
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     function handle($args)
74     {
75         parent::handle($args);
76
77         switch ($this->format) {
78         case 'xml':
79             $this->initDocument('xml');
80             $this->element('version', null, STATUSNET_VERSION);
81             $this->endDocument('xml');
82             break;
83         case 'json':
84             $this->initDocument('json');
85             print '"'.STATUSNET_VERSION.'"';
86             $this->endDocument('json');
87             break;
88         default:
89             $this->clientError(
90                 // TRANS: Client error displayed when coming across a non-supported API method.
91                 _('API method not found.'),
92                 404,
93                 $this->format
94             );
95             break;
96         }
97     }
98
99     /**
100      * Return true if read only.
101      *
102      * MAY override
103      *
104      * @param array $args other arguments
105      *
106      * @return boolean is read only action?
107      */
108     function isReadOnly($args)
109     {
110         return true;
111     }
112 }