@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., * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * http://www.gnu.org/copyleft/gpl.html */ if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production require_once ( 'ApiBase.php' ); } /** * This is the abstract base class for API formatters. * * @ingroup API */ abstract class ApiFormatBase extends ApiBase { private $mIsHtml, $mFormat, $mUnescapeAmps, $mHelp, $mCleared; private $mBufferResult = false, $mBuffer; /** * Constructor * If $format ends with 'fm', pretty-print the output in HTML. * @param $main ApiMain * @param $format string Format name */ public function __construct( $main, $format ) { parent :: __construct( $main, $format ); $this->mIsHtml = ( substr( $format, - 2, 2 ) === 'fm' ); // ends with 'fm' if ( $this->mIsHtml ) $this->mFormat = substr( $format, 0, - 2 ); // remove ending 'fm' else $this->mFormat = $format; $this->mFormat = strtoupper( $this->mFormat ); $this->mCleared = false; } /** * Overriding class returns the mime type that should be sent to the client. * This method is not called if getIsHtml() returns true. * @return string */ public abstract function getMimeType(); /** * Whether this formatter needs raw data such as _element tags * @return bool */ public function getNeedsRawData() { return false; } /** * Get the internal format name * @return string */ public function getFormat() { return $this->mFormat; } /** * Specify whether or not sequences like " should be unescaped * to " . This should only be set to true for the help message * when rendered in the default (xmlfm) format. This is a temporary * special-case fix that should be removed once the help has been * reworked to use a fully HTML interface. * * @param $b bool Whether or not ampersands should be escaped. */ public function setUnescapeAmps ( $b ) { $this->mUnescapeAmps = $b; } /** * Returns true when the HTML pretty-printer should be used. * The default implementation assumes that formats ending with 'fm' * should be formatted in HTML. * @return bool */ public function getIsHtml() { return $this->mIsHtml; } /** * Whether this formatter can format the help message in a nice way. * By default, this returns the same as getIsHtml(). * When action=help is set explicitly, the help will always be shown * @return bool */ public function getWantsHelp() { return $this->getIsHtml(); } /** * Initialize the printer function and prepare the output headers, etc. * This method must be the first outputing method during execution. * A help screen's header is printed for the HTML-based output * @param $isError bool Whether an error message is printed */ function initPrinter( $isError ) { $isHtml = $this->getIsHtml(); $mime = $isHtml ? 'text/html' : $this->getMimeType(); $script = wfScript( 'api' ); // Some printers (ex. Feed) do their own header settings, // in which case $mime will be set to null if ( is_null( $mime ) ) return; // skip any initialization header( "Content-Type: $mime; charset=utf-8" ); if ( $isHtml ) { ?> mUnescapeAmps ) { ?> MediaWiki API MediaWiki API Result
You are looking at the HTML representation of the mFormat ); ?> format.
HTML is good for debugging, but probably is not suitable for your application.
See complete documentation, or API help for more information.
getIsHtml() ) {
?>

mBufferResult ) { $this->mBuffer = $text; } elseif ( $this->getIsHtml() ) { echo $this->formatHTML( $text ); } else { // For non-HTML output, clear all errors that might have been // displayed if display_errors=On // Do this only once, of course if ( !$this->mCleared ) { ob_clean(); $this->mCleared = true; } echo $text; } } /** * Get the contents of the buffer. */ public function getBuffer() { return $this->mBuffer; } /** * Set the flag to buffer the result instead of printing it. */ public function setBufferResult( $value ) { $this->mBufferResult = $value; } /** * Sets whether the pretty-printer should format *bold* and $italics$ * @param $help bool */ public function setHelp( $help = true ) { $this->mHelp = true; } /** * Prety-print various elements in HTML format, such as xml tags and * URLs. This method also escapes characters like < * @param $text string * @return string */ protected function formatHTML( $text ) { global $wgUrlProtocols; // Escape everything first for full coverage $text = htmlspecialchars( $text ); // encode all comments or tags as safe blue strings $text = preg_replace( '/\<(!--.*?--|.*?)\>/', '<\1>', $text ); // identify URLs $protos = implode( "|", $wgUrlProtocols ); // This regex hacks around bug 13218 (" included in the URL) $text = preg_replace( "#(($protos).*?)(")?([ \\'\"<>\n]|<|>|")#", '\\1\\3\\4', $text ); // identify requests to api.php $text = preg_replace( "#api\\.php\\?[^ \\()<\n\t]+#", '\\0', $text ); if ( $this->mHelp ) { // make strings inside * bold $text = preg_replace( "#\\*[^<>\n]+\\*#", '\\0', $text ); // make strings inside $ italic $text = preg_replace( "#\\$[^<>\n]+\\$#", '\\0', $text ); } /* Temporary fix for bad links in help messages. As a special case, * XML-escaped metachars are de-escaped one level in the help message * for legibility. Should be removed once we have completed a fully-html * version of the help message. */ if ( $this->mUnescapeAmps ) $text = preg_replace( '/&(amp|quot|lt|gt);/', '&\1;', $text ); return $text; } protected function getExamples() { return 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName(); } public function getDescription() { return $this->getIsHtml() ? ' (pretty-print in HTML)' : ''; } public static function getBaseVersion() { return __CLASS__ . ': $Id: ApiFormatBase.php 62367 2010-02-12 14:09:42Z siebrand $'; } } /** * This printer is used to wrap an instance of the Feed class * @ingroup API */ class ApiFormatFeedWrapper extends ApiFormatBase { public function __construct( $main ) { parent :: __construct( $main, 'feed' ); } /** * Call this method to initialize output data. See execute() * @param $result ApiResult * @param $feed object an instance of one of the $wgFeedClasses classes * @param $feedItems array of FeedItem objects */ public static function setResult( $result, $feed, $feedItems ) { // Store output in the Result data. // This way we can check during execution if any error has occured // Disable size checking for this because we can't continue // cleanly; size checking would cause more problems than it'd // solve $result->disableSizeCheck(); $result->addValue( null, '_feed', $feed ); $result->addValue( null, '_feeditems', $feedItems ); $result->enableSizeCheck(); } /** * Feed does its own headers */ public function getMimeType() { return null; } /** * Optimization - no need to sanitize data that will not be needed */ public function getNeedsRawData() { return true; } /** * This class expects the result data to be in a custom format set by self::setResult() * $result['_feed'] - an instance of one of the $wgFeedClasses classes * $result['_feeditems'] - an array of FeedItem instances */ public function execute() { $data = $this->getResultData(); if ( isset ( $data['_feed'] ) && isset ( $data['_feeditems'] ) ) { $feed = $data['_feed']; $items = $data['_feeditems']; $feed->outHeader(); foreach ( $items as & $item ) $feed->outItem( $item ); $feed->outFooter(); } else { // Error has occured, print something useful ApiBase::dieDebug( __METHOD__, 'Invalid feed class/item' ); } } public function getVersion() { return __CLASS__ . ': $Id: ApiFormatBase.php 62367 2010-02-12 14:09:42Z siebrand $'; } }