actions/apignusocialversion.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   GNUsocial
  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://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  * should make things a bit easier for upgrades.
  36  * URL: http://identi.ca/api/statusnet/version.(xml|json)
  37  * Formats: xml, js
  38  *
  39  * @category API
  40  * @package  GNUsocial
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @author   Zach Copley <zach@status.net>
  43  * @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         switch ($this->format) {
  53         case 'xml':
  54             $this->initDocument('xml');
  55             $this->element('version', null, GNUSOCIAL_VERSION);
  56             $this->endDocument('xml');
  57             break;
  58         case 'json':
  59             $this->initDocument('json');
  60             print '"'.GNUSOCIAL_VERSION.'"';
  61             $this->endDocument('json');
  62             break;
  63         default:
  64             // TRANS: Client error displayed when coming across a non-supported API method.
  65             $this->clientError(_('API method not found.'), 404);
  66         }
  67     }
  68
  69     /**
  70      * Return true if read only.
  71      *
  72      * MAY override
  73      *
  74      * @param array $args other arguments
  75      *
  76      * @return boolean is read only action?
  77      */
  78     function isReadOnly(array $args=array())
  79     {
  80         return true;
  81     }
  82 }