wiki.techinc.nl/includes/api/ApiFormatRaw.php
Antoine Musso 4f5d2386f3 escape HTML elements in docblock with double quotes
Doxygen choke on text enclosed by '<' and '>' since it tries to
interpret them as HTML or XML elements. This patch adds double quotes
in includes/api/*.php files around the two following strings:

 <Firstname>.<Lastname>@gmail.com
 <Firstname><Lastname>@gmail.com

Which becomes:

 "<Firstname>.<Lastname>@gmail.com"
 "<Firstname><Lastname>@gmail.com"

Tested locally, it prevents doxygen 1.8.0 related warnings.

Change-Id: I36d82eb3fd4989ee3ffc65b0b527b83711d1ba69
2012-07-15 22:15:45 +02:00

73 lines
1.9 KiB
PHP

<?php
/**
*
*
* Created on Feb 2, 2009
*
* Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* Formatter that spits out anything you like with any desired MIME type
* @ingroup API
*/
class ApiFormatRaw extends ApiFormatBase {
/**
* Constructor
* @param $main ApiMain object
* @param $errorFallback ApiFormatBase object to fall back on for errors
*/
public function __construct( $main, $errorFallback ) {
parent::__construct( $main, 'raw' );
$this->mErrorFallback = $errorFallback;
}
public function getMimeType() {
$data = $this->getResultData();
if ( isset( $data['error'] ) ) {
return $this->mErrorFallback->getMimeType();
}
if ( !isset( $data['mime'] ) ) {
ApiBase::dieDebug( __METHOD__, 'No MIME type set for raw formatter' );
}
return $data['mime'];
}
public function execute() {
$data = $this->getResultData();
if ( isset( $data['error'] ) ) {
$this->mErrorFallback->execute();
return;
}
if ( !isset( $data['text'] ) ) {
ApiBase::dieDebug( __METHOD__, 'No text given for raw formatter' );
}
$this->printText( $data['text'] );
}
public function getVersion() {
return __CLASS__ . ': $Id$';
}
}