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
set the description text.
 * addDescription( $text);
 * $text:

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

addOption
is the param required? is an argument required with this option? character to use as short name The shortname would be, e.g., 'm' if you wanted -mFast to be an alternative to --mode=Fast.
 * addOption($name, $description, $required=false, $withArg=false, $shortName=false);
 * $required:
 * $withArg:
 * $shortName:

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

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

outPut

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

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

==See also== wri-man-script>Special:MyLanguage/Manual:Writing maintenance scripts|Manual:Writing maintenance scripts