actions/apigroupshow.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show information about a group
   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  * Outputs detailed information about the group specified by ID
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45
  46 class ApiGroupShowAction extends ApiAction
  47 {
  48     var $group = null;
  49
  50     /**
  51      * Take arguments for running
  52      *
  53      * @param array $args $_REQUEST args
  54      *
  55      * @return boolean success flag
  56      *
  57      */
  58
  59     function prepare($args)
  60     {
  61         parent::prepare($args);
  62
  63         $this->group = $this->getTargetGroup($this->arg('id'));
  64
  65         return true;
  66     }
  67
  68     /**
  69      * Handle the request
  70      *
  71      * Check the format and show the user info
  72      *
  73      * @param array $args $_REQUEST data (unused)
  74      *
  75      * @return void
  76      */
  77
  78     function handle($args)
  79     {
  80         parent::handle($args);
  81
  82         if (empty($this->group)) {
  83             $this->clientError(
  84                 'Group not found!',
  85                 404,
  86                 $this->format
  87             );
  88             return;
  89         }
  90
  91         switch($this->format) {
  92         case 'xml':
  93             $this->show_single_xml_group($this->group);
  94             break;
  95         case 'json':
  96             $this->showSingleJsonGroup($this->group);
  97             break;
  98         default:
  99             $this->clientError(_('API method not found!'), 404, $this->format);
 100             break;
 101         }
 102
 103     }
 104
 105     /**
 106      * When was this group last modified?
 107      *
 108      * @return string datestamp of the latest notice in the stream
 109      */
 110
 111     function lastModified()
 112     {
 113         if (!empty($this->group)) {
 114             return strtotime($this->group->modified);
 115         }
 116
 117         return null;
 118     }
 119
 120     /**
 121      * An entity tag for this group
 122      *
 123      * Returns an Etag based on the action name, language, and
 124      * timestamps of the notice
 125      *
 126      * @return string etag
 127      */
 128
 129     function etag()
 130     {
 131         if (!empty($this->group)) {
 132
 133             return '"' . implode(
 134                 ':',
 135                 array($this->arg('action'),
 136                       common_language(),
 137                       $this->group->id,
 138                       strtotime($this->group->modified))
 139             )
 140             . '"';
 141         }
 142
 143         return null;
 144     }
 145
 146 }