MediaWiki REL1_34
formatInstallDoc.php
Go to the documentation of this file.
1<?php
24use MediaWiki\MediaWikiServices;
25
26require_once __DIR__ . '/Maintenance.php';
27
33class FormatInstallDoc extends Maintenance {
34 function __construct() {
35 parent::__construct();
36 $this->addArg( 'path', 'The file name to format', false );
37 $this->addOption( 'outfile', 'The output file name', false, true );
38 $this->addOption( 'html', 'Use HTML output format. By default, wikitext is used.' );
39 }
40
41 function execute() {
42 if ( $this->hasArg( 0 ) ) {
43 $fileName = $this->getArg( 0 );
44 $inFile = fopen( $fileName, 'r' );
45 if ( !$inFile ) {
46 $this->fatalError( "Unable to open input file \"$fileName\"" );
47 }
48 } else {
49 $inFile = STDIN;
50 }
51
52 if ( $this->hasOption( 'outfile' ) ) {
53 $fileName = $this->getOption( 'outfile' );
54 $outFile = fopen( $fileName, 'w' );
55 if ( !$outFile ) {
56 $this->fatalError( "Unable to open output file \"$fileName\"" );
57 }
58 } else {
59 $outFile = STDOUT;
60 }
61
62 $inText = stream_get_contents( $inFile );
63 $outText = InstallDocFormatter::format( $inText );
64
65 if ( $this->hasOption( 'html' ) ) {
66 $parser = MediaWikiServices::getInstance()->getParser();
67 $opt = new ParserOptions;
68 $title = Title::newFromText( 'Text file' );
69 $out = $parser->parse( $outText, $title, $opt );
70 $outText = "<html><body>\n" . $out->getText() . "\n</body></html>\n";
71 }
72
73 fwrite( $outFile, $outText );
74 }
75}
76
77$maintClass = FormatInstallDoc::class;
78require_once RUN_MAINTENANCE_IF_MAIN;
RUN_MAINTENANCE_IF_MAIN
const RUN_MAINTENANCE_IF_MAIN
Definition Maintenance.php:39
FormatInstallDoc
Maintenance script that formats RELEASE-NOTE file to wiki text or HTML markup.
Definition formatInstallDoc.php:33
FormatInstallDoc\execute
execute()
Do the actual work.
Definition formatInstallDoc.php:41
FormatInstallDoc\__construct
__construct()
Default constructor.
Definition formatInstallDoc.php:34
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition Maintenance.php:82
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition Maintenance.php:319
Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition Maintenance.php:357
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option exists.
Definition Maintenance.php:288
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition Maintenance.php:371
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition Maintenance.php:267
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition Maintenance.php:302
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition Maintenance.php:504
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition MediaWikiServices.php:117
ParserOptions
Set options of the Parser.
Definition ParserOptions.php:42