MediaWiki REL1_33
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;
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition APACHE-LICENSE-2.0.txt:10
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.txt:39
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition Maintenance.php:300
Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition Maintenance.php:338
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option exists.
Definition Maintenance.php:269
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition Maintenance.php:352
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition Maintenance.php:248
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition Maintenance.php:283
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition Maintenance.php:485
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition MediaWikiServices.php:103
ParserOptions
Set options of the Parser.
Definition ParserOptions.php:42
$parser
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition hooks.txt:1834
$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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:855
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:955
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:37
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition maintenance.txt:50