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         private $errorFallback;
  34
  35         /**
  36          * @param ApiMain $main
  37          * @param ApiFormatBase $errorFallback Object to fall back on for errors
  38          */
  39         public function __construct( ApiMain $main, ApiFormatBase $errorFallback ) {
  40                 parent::__construct( $main, 'raw' );
  41                 $this->errorFallback = $errorFallback;
  42         }
  43
  44         public function getMimeType() {
  45                 $data = $this->getResult()->getResultData();
  46
  47                 if ( isset( $data['error'] ) ) {
  48                         return $this->errorFallback->getMimeType();
  49                 }
  50
  51                 if ( !isset( $data['mime'] ) ) {
  52                         ApiBase::dieDebug( __METHOD__, 'No MIME type set for raw formatter' );
  53                 }
  54
  55                 return $data['mime'];
  56         }
  57
  58         public function initPrinter( $unused = false ) {
  59                 $data = $this->getResult()->getResultData();
  60                 if ( isset( $data['error'] ) ) {
  61                         $this->errorFallback->initPrinter( $unused );
  62                 } else {
  63                         parent::initPrinter( $unused );
  64                 }
  65         }
  66
  67         public function closePrinter() {
  68                 $data = $this->getResult()->getResultData();
  69                 if ( isset( $data['error'] ) ) {
  70                         $this->errorFallback->closePrinter();
  71                 } else {
  72                         parent::closePrinter();
  73                 }
  74         }
  75
  76         public function execute() {
  77                 $data = $this->getResult()->getResultData();
  78                 if ( isset( $data['error'] ) ) {
  79                         $this->errorFallback->execute();
  80                         return;
  81                 }
  82
  83                 if ( !isset( $data['text'] ) ) {
  84                         ApiBase::dieDebug( __METHOD__, 'No text given for raw formatter' );
  85                 }
  86                 $this->printText( $data['text'] );
  87         }
  88 }