includes/api/ApiFormatYaml.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 19, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan <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 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( 'ApiFormatBase.php' );
  30 }
  31
  32 /**
  33  * API YAML output formatter
  34  * @ingroup API
  35  */
  36 class ApiFormatYaml extends ApiFormatBase {
  37
  38         public function __construct( $main, $format ) {
  39                 parent::__construct( $main, $format );
  40         }
  41
  42         public function getMimeType() {
  43                 return 'application/yaml';
  44         }
  45
  46         public function execute() {
  47                 $this->printText( Spyc::YAMLDump( $this->getResultData() ) );
  48         }
  49
  50         public function getDescription() {
  51                 return 'Output data in YAML format' . parent::getDescription();
  52         }
  53
  54         public function getVersion() {
  55                 return __CLASS__ . ': $Id$';
  56         }
  57 }