MediaWiki REL1_32
parse.php
Go to the documentation of this file.
1<?php
2
4
55require_once __DIR__ . '/Maintenance.php';
56
62class CLIParser extends Maintenance {
63 protected $parser;
64
65 public function __construct() {
66 parent::__construct();
67 $this->addDescription( 'Parse a given wikitext' );
68 $this->addOption(
69 'title',
70 'Title name for the given wikitext (Default: \'CLIParser\')',
71 false,
72 true
73 );
74 $this->addOption( 'no-tidy', 'Don\'t tidy the output (deprecated)' );
75 $this->addArg( 'file', 'File containing wikitext (Default: stdin)', false );
76 }
77
78 public function execute() {
79 $this->initParser();
80 print $this->render( $this->Wikitext() );
81 }
82
87 public function render( $wikitext ) {
88 return $this->parse( $wikitext )->getText( [ 'wrapperDivClass' => '' ] );
89 }
90
95 protected function Wikitext() {
96 $php_stdin = 'php://stdin';
97 $input_file = $this->getArg( 0, $php_stdin );
98
99 if ( $input_file === $php_stdin && !$this->mQuiet ) {
100 $ctrl = wfIsWindows() ? 'CTRL+Z' : 'CTRL+D';
101 $this->error( basename( __FILE__ )
102 . ": warning: reading wikitext from STDIN. Press $ctrl to parse.\n" );
103 }
104
105 return file_get_contents( $input_file );
106 }
107
108 protected function initParser() {
109 $this->parser = MediaWikiServices::getInstance()->getParserFactory()->create();
110 }
111
119 protected function getTitle() {
120 $title = $this->getOption( 'title' )
121 ? $this->getOption( 'title' )
122 : 'CLIParser';
123
124 return Title::newFromText( $title );
125 }
126
131 protected function parse( $wikitext ) {
132 $options = ParserOptions::newCanonical();
133 $options->setOption( 'enableLimitReport', false );
134 if ( $this->getOption( 'no-tidy' ) ) {
135 $options->setTidy( false );
136 }
137 return $this->parser->parse(
138 $wikitext,
139 $this->getTitle(),
141 );
142 }
143}
144
145$maintClass = CLIParser::class;
146require_once RUN_MAINTENANCE_IF_MAIN;
wfIsWindows()
Check if the operating system is Windows.
Maintenance script to parse some wikitext.
Definition parse.php:62
execute()
Do the actual work.
Definition parse.php:78
getTitle()
Title object to use for CLI parsing.
Definition parse.php:119
parse( $wikitext)
Definition parse.php:131
__construct()
Default constructor.
Definition parse.php:65
Wikitext()
Get wikitext from a the file passed as argument or STDIN.
Definition parse.php:95
initParser()
Definition parse.php:108
render( $wikitext)
Definition parse.php:87
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
addArg( $arg, $description, $required=true)
Add some args that are needed.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
MediaWikiServices is the service locator for the application scope of MediaWiki.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2683
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:2050
while(( $__line=Maintenance::readconsole()) !==false) print
Definition eval.php:64
require_once RUN_MAINTENANCE_IF_MAIN
$maintClass
Definition parse.php:145