Manual:Writing maintenance scripts/fr

La version 1.16 de MediaWiki a introduit la class maintenance pour rendre plus simple l'écriture de lignes de commande pour les scripts de maintenance MediaWiki.

Script exemple
Pour décrire ces csripts de maintenance, nous décrirons les étape d'écriture de, un script qui ne fait qu'une chose, afficher "Salut, Monde". Ce programme contiendra le minimum de code nécessaire à son lancement ainsi que les en-têtes requises pour les droits d'auteur (pour des d'autres en-têtes possibles, lire en tête de droit d'auteur):

Le programme, malgré sa simplicité, aura déja une option --help et d'autres options de ligne de commande. Une sortie possible:

 $ 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.

$

Un aperçu:


 * Bien sur, si nous écrivons un script de maintenance, nous devons inclure Maintenance.php. Cela permet de ne pas avoir à s'occuper de la mise en place d'Autoloading et similaires. Il est conseillé d'utiliser le chemin complet vers Maintenance.php.


 * Nous écrasons la classe Maintenance, puis dans


 * utiliser la class Maintenance de façon a lancer la classe HelloWorld, uniquement si le script est utilisé en ligne de commande.

Internally,  loads another file  which autoloads MediaWiki classes and configuration, and then


 * La fonction execute que nous avons fourni est lancée.

Ajouter une 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] …

Analyse des option et Argument
Saluer le monde est tout sympathique et très bien, mais nous voulons être capable de saluer également des individus.

Pour ajouter une option, ajouter un constructeur avec un appel  et mettre à jour la méthode   pour utiliser une nouvelle option. Les paramètres de  sont are $name, $description, $required = false, $withArg = false, $shortName = false:

Cette fois, à l'exécution, la sortie de  change en fonction des arguments fournis:

 $ 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.

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.