MediaWiki  master
CommandLineInc.php
Go to the documentation of this file.
1 <?php
24 // NO_AUTOLOAD -- unsafe file-scope code
25 
26 require_once __DIR__ . '/Maintenance.php';
27 
29 
30 if ( !isset( $optionsWithArgs ) ) {
31  $optionsWithArgs = [];
32 }
33 if ( !isset( $optionsWithoutArgs ) ) {
35 }
36 if ( !isset( $allowUnregisteredOptions ) ) {
38 }
39 
40 class CommandLineInc extends Maintenance {
41  public function __construct() {
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  global $args, $options;
69 
71  $options = $this->mOptions;
72  }
73 }
74 
75 $maintClass = CommandLineInc::class;
76 require_once RUN_MAINTENANCE_IF_MAIN;
$optionsWithArgs
global $optionsWithArgs
Definition: CommandLineInc.php:26
$allowUnregisteredOptions
global $allowUnregisteredOptions
Definition: CommandLineInc.php:28
CommandLineInc
Definition: CommandLineInc.php:40
CommandLineInc\maybeHelp
maybeHelp( $force=false)
No help, it would just be misleading since it misses custom options.
Definition: CommandLineInc.php:60
$maintClass
$maintClass
Definition: CommandLineInc.php:75
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:59
CommandLineInc\__construct
__construct()
Default constructor.
Definition: CommandLineInc.php:41
Maintenance\$mArgs
array $mArgs
This is the list of arguments that were actually passed.
Definition: Maintenance.php:88
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:249
$args
if( $line===false) $args
Definition: mcc.php:124
Maintenance\$mOptions
array $mOptions
This is the list of options that were actually passed.
Definition: Maintenance.php:85
$optionsWithoutArgs
global $optionsWithoutArgs
Definition: CommandLineInc.php:28
Maintenance\setAllowUnregisteredOptions
setAllowUnregisteredOptions( $allow)
Sets whether to allow unregistered options, which are options passed to a script that do not match an...
Definition: Maintenance.php:321
CommandLineInc\execute
execute()
Do the actual work.
Definition: CommandLineInc.php:67