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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/api.php';
  35
  36 /**
  37  * Returns a version number for this version of StatusNet, which
  38  * should make things a bit easier for upgrades.
  39  * URL: http://identi.ca/api/statusnet/version.(xml|json)
  40  * Formats: xml, js
  41  *
  42  * @category API
  43  * @package  StatusNet
  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
  49 class ApiStatusnetVersionAction extends TwitterApiAction
  50 {
  51     var $format = null;
  52
  53     /**
  54      * Take arguments for running
  55      *
  56      * @param array $args $_REQUEST args
  57      *
  58      * @return boolean success flag
  59      *
  60      */
  61
  62     function prepare($args)
  63     {
  64         parent::prepare($args);
  65         $this->format = $this->arg('format');
  66         return true;
  67     }
  68
  69     /**
  70      * Handle the request
  71      *
  72      * @param array $args $_REQUEST data (unused)
  73      *
  74      * @return void
  75      */
  76
  77     function handle($args)
  78     {
  79         parent::handle($args);
  80
  81         switch ($this->format) {
  82         case 'xml':
  83             $this->init_document('xml');
  84             $this->element('version', null, STATUSNET_VERSION);
  85             $this->end_document('xml');
  86             break;
  87         case 'json':
  88             $this->init_document('json');
  89             print '"'.STATUSNET_VERSION.'"';
  90             $this->end_document('json');
  91             break;
  92         default:
  93             $this->clientError(
  94                 _('API method not found!'),
  95                 404,
  96                 $this->format
  97             );
  98             break;
  99         }
 100     }
 101
 102 }
 103