Manual:Maintenance.php

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Maintenance.php and the translation is 63% complete.

Other languages:
English • ‎dansk • ‎español • ‎polski • ‎português do Brasil • ‎русский • ‎中文 • ‎日本語

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

関数

addDescription()

  • addDescription( $text);
    • $text: 説明テキストを設定します。

addArg()

  • addArg( $arg, $description, $required = true );
    • $arg: 引数名
    • $description: 引数の短い説明
    • $required: 必須かどうか

addOption()

  • addOption($name, $description, $required=false, $withArg=false, $shortName=false);
    • $required: パラメーターが必須かどうか
    • $withArg: is an argument required with this option?
    • $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

関連項目