MediaWiki  1.30.0
formatInstallDoc.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
31 class MaintenanceFormatInstallDoc 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->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' ) ) {
66  global $wgParser;
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:40
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:268
MaintenanceFormatInstallDoc\execute
execute()
Do the actual work.
Definition: formatInstallDoc.php:39
$wgParser
$wgParser
Definition: Setup.php:824
$opt
$opt
Definition: postprocess-phan.php:115
MaintenanceFormatInstallDoc\__construct
__construct()
Default constructor.
Definition: formatInstallDoc.php:32
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:296
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:215
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
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:250
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:267
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:392
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:236
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:306
$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:781