apignusocialversion.php 2.56 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * A version stamp for the API
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  API
23
 * @package   GNUsocial
Zach Copley's avatar
Zach Copley committed
24
 * @author    Evan Prodromou <evan@status.net>
25 26 27
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28
 * @link      http://www.gnu.org/software/social/
29 30
 */

31
if (!defined('GNUSOCIAL')) { exit(1); }
32 33

/**
34
 * Returns a version number for this version of GNU social, which
35 36 37 38 39
 * should make things a bit easier for upgrades.
 * URL: http://identi.ca/api/statusnet/version.(xml|json)
 * Formats: xml, js
 *
 * @category API
40
 * @package  GNUsocial
Zach Copley's avatar
Zach Copley committed
41
 * @author   Evan Prodromou <evan@status.net>
42 43
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
44
 * @link     http://www.gnu.org/software/social/
45
 */
46
class ApiGNUsocialVersionAction extends ApiPrivateAuthAction
47
{
48
    protected function handle()
49
    {
50
        parent::handle();
51 52 53

        switch ($this->format) {
        case 'xml':
54
            $this->initDocument('xml');
55
            $this->element('version', null, GNUSOCIAL_VERSION);
56
            $this->endDocument('xml');
57 58
            break;
        case 'json':
59
            $this->initDocument('json');
60
            print '"'.GNUSOCIAL_VERSION.'"';
61
            $this->endDocument('json');
62 63
            break;
        default:
64 65
            // TRANS: Client error displayed when coming across a non-supported API method.
            $this->clientError(_('API method not found.'), 404);
66 67 68
        }
    }

69 70 71 72 73 74 75 76 77 78 79 80 81
    /**
     * Return true if read only.
     *
     * MAY override
     *
     * @param array $args other arguments
     *
     * @return boolean is read only action?
     */
    function isReadOnly($args)
    {
        return true;
    }
82
}