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 100% complete.

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

A classe Maintenance é a classe abstrata de manutenção que permite escrever scripts de manutenção rapidamente com o mínimo esforço.

Funções

addDescription()

  • addDescription( $text);
    • $text: define o texto de descrição.

addArg()

  • addArg( $arg, $description, $required = true );
    • $arg: nome do argumento
    • $description: breve descrição do argumento
    • $required: este campo é necessário?

addOption()

  • addOption($name, $description, $required=false, $withArg=false, $shortName=false);
    • $required: este parâmetro é necessário?
    • $withArg: este é um argumento requerido com esta opção?
    • $shortName: caractere a ser usado como nome curto

O nome abreviado poderia ser, por exemplo, 'm' se você desejar -mFast como uma alternativa para --mode=Fast.

getArg()

  • getArg( $argId = 0, $default = null );
    • $argId: o valor inteiro (a partir de zero) para o argumento
    • $default: o valor padrão se ele não existe.

getOption()

  • getOption( $name, $default = null );
    • $name: nome do parâmetro
    • $default: valor padrão.

outPut()

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

runChild()

  • runChild( $maintClass, $classFile = null );
    • maintClass: um nome de uma classe filha de manutenção
    • $classFile: caminho completo onde a classe filha está.

Ver também