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