includes/api/ApiFormatRaw.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Feb 2, 2009
   6  *
   7  * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * Formatter that spits out anything you like with any desired MIME type
  29  * @ingroup API
  30  */
  31 class ApiFormatRaw extends ApiFormatBase {
  32
  33         /**
  34          * Constructor
  35          * @param $main ApiMain object
  36          * @param $errorFallback ApiFormatBase object to fall back on for errors
  37          */
  38         public function __construct( $main, $errorFallback ) {
  39                 parent::__construct( $main, 'raw' );
  40                 $this->mErrorFallback = $errorFallback;
  41         }
  42
  43         public function getMimeType() {
  44                 $data = $this->getResultData();
  45
  46                 if ( isset( $data['error'] ) ) {
  47                         return $this->mErrorFallback->getMimeType();
  48                 }
  49
  50                 if ( !isset( $data['mime'] ) ) {
  51                         ApiBase::dieDebug( __METHOD__, 'No MIME type set for raw formatter' );
  52                 }
  53
  54                 return $data['mime'];
  55         }
  56
  57         public function execute() {
  58                 $data = $this->getResultData();
  59                 if ( isset( $data['error'] ) ) {
  60                         $this->mErrorFallback->execute();
  61                         return;
  62                 }
  63
  64                 if ( !isset( $data['text'] ) ) {
  65                         ApiBase::dieDebug( __METHOD__, 'No text given for raw formatter' );
  66                 }
  67                 $this->printText( $data['text'] );
  68         }
  69
  70         public function getVersion() {
  71                 return __CLASS__ . ': $Id$';
  72         }
  73 }