MediaWiki  master
formatInstallDoc.php
Go to the documentation of this file.
1 <?php
24 use MediaWiki\Title\Title;
25 
26 require_once __DIR__ . '/Maintenance.php';
27 
33 class FormatInstallDoc extends Maintenance {
34  public 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  public 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 = $this->getServiceContainer()->getParser();
67  $opt = ParserOptions::newFromAnon();
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;
78 require_once RUN_MAINTENANCE_IF_MAIN;
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:66
Maintenance\addArg
addArg( $arg, $description, $required=true, $multi=false)
Add some args that are needed.
Definition: Maintenance.php:300
Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition: Maintenance.php:335
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option was set.
Definition: Maintenance.php:274
Maintenance\getServiceContainer
getServiceContainer()
Returns the main service container.
Definition: Maintenance.php:637
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:347
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:255
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:289
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:517
MediaWiki\Title\Title
Represents a title within MediaWiki.
Definition: Title.php:76
ParserOptions\newFromAnon
static newFromAnon()
Get a ParserOptions object for an anonymous user.
Definition: ParserOptions.php:1074
$maintClass
$maintClass
Definition: formatInstallDoc.php:77