ApiExpandTemplates.php

Go to the documentation of this file.

<?php
class ApiExpandTemplates extends ApiBase {

        public function execute() {
                // Cache may vary on $wgUser because ParserOptions gets data from it
                $this->getMain()->setCacheMode( 'anon-public-user-private' );

                // Get parameters
                $params = $this->extractRequestParams();

                // Create title for parser
                $title_obj = Title::newFromText( $params['title'] );
                if ( !$title_obj || $title_obj->isExternal() ) {
                        $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
                }

                $result = $this->getResult();

                // Parse text
                global $wgParser;
                $options = ParserOptions::newFromContext( $this->getContext() );

                if ( $params['includecomments'] ) {
                        $options->setRemoveComments( false );
                }

                if ( $params['generatexml'] ) {
                        $wgParser->startExternalParse( $title_obj, $options, OT_PREPROCESS );
                        $dom = $wgParser->preprocessToDom( $params['text'] );
                        if ( is_callable( array( $dom, 'saveXML' ) ) ) {
                                $xml = $dom->saveXML();
                        } else {
                                $xml = $dom->__toString();
                        }
                        $xml_result = array();
                        $result->setContent( $xml_result, $xml );
                        $result->addValue( null, 'parsetree', $xml_result );
                }
                $retval = $wgParser->preprocess( $params['text'], $title_obj, $options );

                // Return result
                $retval_array = array();
                $result->setContent( $retval_array, $retval );
                $result->addValue( null, $this->getModuleName(), $retval_array );
        }

        public function getAllowedParams() {
                return array(
                        'title' => array(
                                ApiBase::PARAM_DFLT => 'API',
                        ),
                        'text' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true,
                        ),
                        'generatexml' => false,
                        'includecomments' => false,
                );
        }

        public function getParamDescription() {
                return array(
                        'text' => 'Wikitext to convert',
                        'title' => 'Title of page',
                        'generatexml' => 'Generate XML parse tree',
                        'includecomments' => 'Whether to include HTML comments in the output',
                );
        }

        public function getResultProperties() {
                return array(
                        '' => array(
                                '*' => 'string'
                        )
                );
        }

        public function getDescription() {
                return 'Expands all templates in wikitext';
        }

        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'invalidtitle', 'title' ),
                ) );
        }

        public function getExamples() {
                return array(
                        'api.php?action=expandtemplates&text={{Project:Sandbox}}'
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:Parsing_wikitext#expandtemplates';
        }
}