MediaWiki  1.23.6
formatInstallDoc.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
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->error( "Unable to open input file \"$fileName\"" );
45  exit( 1 );
46  }
47  } else {
48  $inFile = STDIN;
49  }
50 
51  if ( $this->hasOption( 'outfile' ) ) {
52  $fileName = $this->getOption( 'outfile' );
53  $outFile = fopen( $fileName, 'w' );
54  if ( !$outFile ) {
55  $this->error( "Unable to open output file \"$fileName\"" );
56  exit( 1 );
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' ) ) {
67  $opt = new ParserOptions;
68  $title = Title::newFromText( 'Text file' );
69  $out = $wgParser->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 = 'MaintenanceFormatInstallDoc';
78 require_once RUN_MAINTENANCE_IF_MAIN;
MaintenanceFormatInstallDoc
Maintenance script that formats RELEASE-NOTE file to wiki text or HTML markup.
Definition: formatInstallDoc.php:31
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:31
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:189
MaintenanceFormatInstallDoc\execute
execute()
Do the actual work.
Definition: formatInstallDoc.php:39
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
MaintenanceFormatInstallDoc\__construct
__construct()
Default constructor.
Definition: formatInstallDoc.php:32
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false)
Add a parameter to the script.
Definition: Maintenance.php:169
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition: Maintenance.php:236
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
$out
$out
Definition: UtfNormalGenerate.php:167
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
InstallDocFormatter\format
static format( $text)
Definition: InstallDocFormatter.php:24
$maintClass
$maintClass
Definition: formatInstallDoc.php:77
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:191
$wgParser
$wgParser
Definition: Setup.php:567
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:207
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:333
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:181
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:246