Manual:Maintenance.php

Not to be confused with another file called Maintenance.php, which is in the maintenance folder.

MediaWiki file: Maintenance.php
Location:	maintenance/includes/
Source code:	master • 1.43.0 • 1.42.4 • 1.39.11
Classes:	Maintenance

The Maintenance class is the abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effort.

Functions

addDescription()

• addDescription( $text);
  • $text: set the description text.

addArg()

• addArg( $arg, $description, $required = true );
  • $arg: name of the arg
  • $description: short description of the arg
  • $required: is this required?

addOption()

• addOption($name, $description, $required=false, $withArg=false, $shortName=false);
  • $required: is the param required?
  • $withArg: is an argument required with this option?
  • $shortName: character to use as short name

The shortname would be, e.g., 'm' if you wanted -mFast to be an alternative to --mode=Fast.

getArg()

• getArg( $argId = 0, $default = null );
  • $argId: the integer value (from zero) for the arg
  • $default: the default if it doesn't exist

getOption()

• getOption( $name, $default = null );
  • $name: the name of the param
  • $default: default

outPut()

• output( $output, $channel = null );

runChild()

• runChild( $maintClass, $classFile = null );
  • maintClass: a name of a child maintenance class
  • $classFile: full path of where the child is

See also

• Manual:Writing maintenance scripts