MediaWiki master
formatInstallDoc.php
Go to the documentation of this file.
1<?php
10use MediaWiki\Installer\InstallDocFormatter;
11use MediaWiki\Maintenance\Maintenance;
12use MediaWiki\Parser\ParserOptions;
13use MediaWiki\Title\Title;
14
15// @codeCoverageIgnoreStart
16require_once __DIR__ . '/Maintenance.php';
17// @codeCoverageIgnoreEnd
18
24class FormatInstallDoc extends Maintenance {
25 public function __construct() {
26 parent::__construct();
27 $this->addArg( 'path', 'The file name to format', false );
28 $this->addOption( 'outfile', 'The output file name', false, true );
29 $this->addOption( 'html', 'Use HTML output format. By default, wikitext is used.' );
30 }
31
32 public function execute() {
33 if ( $this->hasArg( 0 ) ) {
34 $fileName = $this->getArg( 0 );
35 $inFile = fopen( $fileName, 'r' );
36 if ( !$inFile ) {
37 $this->fatalError( "Unable to open input file \"$fileName\"" );
38 }
39 } else {
40 $inFile = STDIN;
41 }
42
43 if ( $this->hasOption( 'outfile' ) ) {
44 $fileName = $this->getOption( 'outfile' );
45 $outFile = fopen( $fileName, 'w' );
46 if ( !$outFile ) {
47 $this->fatalError( "Unable to open output file \"$fileName\"" );
48 }
49 } else {
50 $outFile = STDOUT;
51 }
52
53 $inText = stream_get_contents( $inFile );
54 $outText = InstallDocFormatter::format( $inText );
55
56 if ( $this->hasOption( 'html' ) ) {
57 $parser = $this->getServiceContainer()->getParser();
58 $opt = ParserOptions::newFromAnon();
59 $title = Title::newFromText( 'Text file' );
60 $out = $parser->parse( $outText, $title, $opt );
61 $outText = "<html><body>\n" .
62 // TODO T371008 consider if using the Content framework makes sense instead of creating the pipeline
63 $this->getServiceContainer()->getDefaultOutputPipeline()
64 ->run( $out, $opt, [] )
65 ->getContentHolderText()
66 . "\n</body></html>\n";
67 }
68
69 fwrite( $outFile, $outText );
70 }
71}
72
73// @codeCoverageIgnoreStart
74$maintClass = FormatInstallDoc::class;
75require_once RUN_MAINTENANCE_IF_MAIN;
76// @codeCoverageIgnoreEnd
FormatInstallDoc
Maintenance script that formats RELEASE-NOTE file to wiki text or HTML markup.
Definition formatInstallDoc.php:24
FormatInstallDoc\execute
execute()
Do the actual work.
Definition formatInstallDoc.php:32
FormatInstallDoc\__construct
__construct()
Default constructor.
Definition formatInstallDoc.php:25
MediaWiki\Maintenance\Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition Maintenance.php:65
MediaWiki\Maintenance\Maintenance\addArg
addArg( $arg, $description, $required=true, $multi=false)
Add some args that are needed.
Definition Maintenance.php:311
MediaWiki\Maintenance\Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition Maintenance.php:358
MediaWiki\Maintenance\Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition Maintenance.php:551
MediaWiki\Maintenance\Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition Maintenance.php:266
MediaWiki\Maintenance\Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option was set.
Definition Maintenance.php:285
MediaWiki\Maintenance\Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition Maintenance.php:300
MediaWiki\Maintenance\Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition Maintenance.php:346
MediaWiki\Maintenance\Maintenance\getServiceContainer
getServiceContainer()
Returns the main service container.
Definition Maintenance.php:680
MediaWiki\Parser\ParserOptions
Set options of the Parser.
Definition ParserOptions.php:67
MediaWiki\Title\Title
Represents a title within MediaWiki.
Definition Title.php:69