Manual:Maintenance.php

The Maintenance class is the abstract maintenance class for quickly wri-man-script>Special:MyLanguage/Manual:Writing maintenance scripts|writing and churning out man-script>Special:MyLanguage/Manual:Maintenance scripts|maintenance scripts with minimal effort.

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