MediaWiki  master
commandLine.inc
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
26 // phpcs:ignore MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
28 
29 if ( !isset( $optionsWithArgs ) ) {
30  $optionsWithArgs = [];
31 }
32 if ( !isset( $optionsWithoutArgs ) ) {
33  $optionsWithoutArgs = [];
34 }
35 if ( !isset( $allowUnregisteredOptions ) ) {
36  $allowUnregisteredOptions = false;
37 }
38 
39 class CommandLineInc extends Maintenance {
40  public function __construct() {
41  // phpcs:ignore MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
43 
44  parent::__construct();
45 
46  foreach ( $optionsWithArgs as $name ) {
47  $this->addOption( $name, '', false, true );
48  }
49  foreach ( $optionsWithoutArgs as $name ) {
50  $this->addOption( $name, '', false, false );
51  }
52 
53  $this->setAllowUnregisteredOptions( $allowUnregisteredOptions );
54  }
55 
60  protected function maybeHelp( $force = false ) {
61  if ( !$force ) {
62  return;
63  }
64  parent::maybeHelp( true );
65  }
66 
67  public function execute() {
68  // phpcs:ignore MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
69  global $args, $options;
70 
71  $args = $this->mArgs;
72  $options = $this->mOptions;
73  }
74 }
75 
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
global $optionsWithArgs
Definition: commandLine.inc:24
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
maybeHelp( $force=false)
No help, it would just be misleading since it misses custom options.
Definition: commandLine.inc:60
if( $line===false) $args
Definition: cdb.php:64
global $allowUnregisteredOptions
Definition: commandLine.inc:24
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1982
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
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
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
global $optionsWithoutArgs
Definition: commandLine.inc:24
$maintClass
Definition: commandLine.inc:76
setAllowUnregisteredOptions( $allow)
Sets whether to allow unregistered options, which are options passed to a script that do not match an...