手册:Maintenance.php
Not to be confused with another file called Maintenance.php, which is in the maintenance folder.
| MediaWiki文件： Maintenance.php | |
|---|---|
| 位置： | maintenance/includes/ |
| 源代码： | master • 1.42.3 • 1.41.4 • 1.39.10 |
| 类： | Maintenance |
The Maintenance class is the abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effort.
函数
addDescription()
- addDescription( $text);
- $text: set the description text.
addArg()
- addArg( $arg, $description, $required = true );
- $arg: 参数名称
- $description: 参数的简短描述
- $required: 需要它吗？
addOption()
- addOption($name, $description, $required=false, $withArg=false, $shortName=false);
- $required: 这是必需的参数吗？
- $withArg: 该选项是否需要参数？
- $shortName: 用作短名称的字符
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: 如果它不存在则为默认值
getOption()
- getOption( $name, $default = null );
- $name: 参数的名称
- $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