MediaWiki REL1_32
formatInstallDoc.php
Go to the documentation of this file.
1<?php
24require_once __DIR__ . '/Maintenance.php';
25
31class FormatInstallDoc extends Maintenance {
32 function __construct() {
33 parent::__construct();
34 $this->addArg( 'path', 'The file name to format', false );
35 $this->addOption( 'outfile', 'The output file name', false, true );
36 $this->addOption( 'html', 'Use HTML output format. By default, wikitext is used.' );
37 }
38
39 function execute() {
40 if ( $this->hasArg( 0 ) ) {
41 $fileName = $this->getArg( 0 );
42 $inFile = fopen( $fileName, 'r' );
43 if ( !$inFile ) {
44 $this->fatalError( "Unable to open input file \"$fileName\"" );
45 }
46 } else {
47 $inFile = STDIN;
48 }
49
50 if ( $this->hasOption( 'outfile' ) ) {
51 $fileName = $this->getOption( 'outfile' );
52 $outFile = fopen( $fileName, 'w' );
53 if ( !$outFile ) {
54 $this->fatalError( "Unable to open output file \"$fileName\"" );
55 }
56 } else {
57 $outFile = STDOUT;
58 }
59
60 $inText = stream_get_contents( $inFile );
61 $outText = InstallDocFormatter::format( $inText );
62
63 if ( $this->hasOption( 'html' ) ) {
64 global $wgParser;
65 $opt = new ParserOptions;
66 $title = Title::newFromText( 'Text file' );
67 $out = $wgParser->parse( $outText, $title, $opt );
68 $outText = "<html><body>\n" . $out->getText() . "\n</body></html>\n";
69 }
70
71 fwrite( $outFile, $outText );
72 }
73}
74
75$maintClass = FormatInstallDoc::class;
76require_once RUN_MAINTENANCE_IF_MAIN;
$wgParser
$wgParser
Definition Setup.php:921
FormatInstallDoc
Maintenance script that formats RELEASE-NOTE file to wiki text or HTML markup.
Definition formatInstallDoc.php:31
FormatInstallDoc\execute
execute()
Do the actual work.
Definition formatInstallDoc.php:39
FormatInstallDoc\__construct
__construct()
Default constructor.
Definition formatInstallDoc.php:32
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition maintenance.txt:39
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition Maintenance.php:288
Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition Maintenance.php:326
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option exists.
Definition Maintenance.php:257
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition Maintenance.php:336
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition Maintenance.php:236
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition Maintenance.php:271
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition Maintenance.php:465
ParserOptions
Set options of the Parser.
Definition ParserOptions.php:42
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:894
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition maintenance.txt:50