Manual:Maintenance.php

Not to be confused with another file called Maintenance.php, which is in the maintenance folder.

Arquivo MediaWiki: Maintenance.php
Local:	maintenance/includes/
Código fonte:	master • 1.42.3 • 1.41.4 • 1.39.10
Classes:	Maintenance

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

• Manual:Escrevendo scripts de manutenção