Manual:Writing maintenance scripts/pt-br

Na versão 1.16 do MediaWiki, foi introduzida a classe de manutenção para tornar mais fácil a escrita de scripts de linha de comando de manutenção do software.

Exemplo de script
Para descrever a criação de scripts de manutenção, vamos escrever um arquivo, um script que simplesmente imprime “Hello, World”. Este programa contém a quantidade mínima de código necessário para ser executado, bem como o cabeçalho de direitos autorais esperado (para cabeçalhos alternativos, consulte cabeçalhos de direitos autorais):

O programa simplesmente imprimirá “Hello, World!” porém já possui um parâmetro  (e outras opções de linha de comando). Saída de exemplo:

 $ php helloWorld.php Hello, World! $ php helloWorld.php --help

Usage: php helloWorld.php [--conf|--dbgroupdefault|--dbpass|--dbuser|--globals|--help|--memory-limit|--mwdebug|--profiler|--quiet|--server|--wiki]

Generic maintenance parameters: --help (-h): Display this help message --quiet (-q): Whether to suppress non-error output --conf: Location of LocalSettings.php, if not default --wiki: For specifying the wiki ID   --globals: Output globals at the end of processing for debugging --memory-limit: Set a specific memory limit for the script, "max" for no limit or "default" to avoid changing it   --server: The protocol and server name to use in URLs, e.g.        https://en.wikipedia.org. This is sometimes necessary because server name detection may fail in command line scripts. --profiler: Profiler output format (usually "text") --mwdebug: Enable built-in MediaWiki development settings

Script dependant parameters: --dbuser: The DB user to use for this script --dbpass: The password to use for this script --dbgroupdefault: The default DB group to use.

$

Uma visão geral:


 * Logicamente, se vamos escrever um script de manutenção, temos que incluir . Ele cuida da criação do Autoloading e itens afins. O melhor é usar o caminho completo para.


 * Nós substituímos a classe Maintenance e, em seguida, em


 * dizemos para a classe Maintenance executar o script usando a classe, somente se for executado a partir da linha de comando. Internally,   loads another file  which autoloads MediaWiki classes and configuration, and then


 * A função  que nós fornecemos é executada.

Adding a description
"But what is this maintenance script for?" I can hear you asking.

We can put a description at the top of the " " output by using the  method in our constructor:

The output now gives us the description:

$ php helloWorld.php --help

Say hello.

Usage: php helloWorld.php [--conf|--dbgroupdefault|--dbpass|--dbuser|--globals|--help|--memory-limit|--mwdebug|--profiler|--quiet|--server|--wiki] …

Análise de opções e argumentos
Cumprimentar o mundo está tudo bem, mas nós queremos ser capazes de cumprimentar as pessoas, também.

Para adicionar uma opção, adicione um construtor com uma chamada  e atualize o método   para usar a nova opção. Os parâmetros de addOptionsão $name, $description, $required = false, $withArg = false, $shortName = false:

Desta vez, quando executado, a saída do script helloWorld.php muda, dependendo do argumento fornecido:

 $ php helloWorld.php Hello, World! $ php helloWorld.php --name=Mark Hello, Mark! $ php helloWorld.php --help

Say hello.

Usage: php helloWorld.php [--conf|--dbgroupdefault|--dbpass|--dbuser|--globals|--help|--memory-limit|--mwdebug|--name|--profiler|--quiet|--server|--wiki] … Script specific parameters: --name: Who to say Hello to

Extensions
If your maintenance script is for an extension, then you should add a requirement that the extension is installed:

Mostly this provides a nice error message when the extension is not enabled on that wiki (likely on wiki farms). This will only work for extensions that use.

Be aware that classes defined by your extension will not be available until hitting the execute-function. Attempts to create instances prior to this, e.g. in the constructor, will cause class not found exceptions.

Writing tests
It's recommended to write tests for your maintenance scripts, like with any other class. See the Manual:PHP unit testing/Writing unit tests guide for help and examples.