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 TwitterApiAction
  47 {
  48     var $format = null;
  49     var $group = null;
  50
  51     /**
  52      * Take arguments for running
  53      *
  54      * @param array $args $_REQUEST args
  55      *
  56      * @return boolean success flag
  57      *
  58      */
  59
  60     function prepare($args)
  61     {
  62         parent::prepare($args);
  63
  64         $this->format = $this->arg('format');
  65         $this->group = $this->getTargetGroup($this->arg('id'));
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Handle the request
  72      *
  73      * Check the format and show the user info
  74      *
  75      * @param array $args $_REQUEST data (unused)
  76      *
  77      * @return void
  78      */
  79
  80     function handle($args)
  81     {
  82         parent::handle($args);
  83
  84         if (empty($this->group)) {
  85             $this->clientError(
  86                 'Group not found!',
  87                 404,
  88                 $this->format
  89             );
  90             return;
  91         }
  92
  93         switch($this->format) {
  94         case 'xml':
  95             $this->show_single_xml_group($this->group);
  96             break;
  97         case 'json':
  98             $this->show_single_json_group($this->group);
  99             break;
 100         default:
 101             $this->clientError(_('API method not found!'), 404, $this->format);
 102             break;
 103         }
 104
 105     }
 106
 107     /**
 108      * When was this group last modified?
 109      *
 110      * @return string datestamp of the latest notice in the stream
 111      */
 112
 113     function lastModified()
 114     {
 115         if (!empty($this->group)) {
 116             return strtotime($this->group->modified);
 117         }
 118
 119         return null;
 120     }
 121
 122     /**
 123      * An entity tag for this group
 124      *
 125      * Returns an Etag based on the action name, language, and
 126      * timestamps of the notice
 127      *
 128      * @return string etag
 129      */
 130
 131     function etag()
 132     {
 133         if (!empty($this->group)) {
 134
 135             return '"' . implode(
 136                 ':',
 137                 array($this->arg('action'),
 138                       common_language(),
 139                       $this->group->id,
 140                       strtotime($this->group->modified))
 141             )
 142             . '"';
 143         }
 144
 145         return null;
 146     }
 147
 148 }