Manuel:Maintenance.php
Not to be confused with another file called Maintenance.php, which is in the maintenance folder.
| Fichier MediaWiki : Maintenance.php | |
|---|---|
| Emplacement : | maintenance/includes/ |
| Code source : | master • 1.42.3 • 1.41.4 • 1.39.10 |
| Classes : | Maintenance |
La classe Maintenance est la classe abstraite maintenance pour écrire rapidement et créer les scripts de maintenance avec un minimum d'effort.
Fonctions
addDescription()
- addDescription( $text);
- $text: définir le texte de description.
addArg()
- addArg( $arg, $description, $required = true );
- $arg: nom de l'argument
- $description: brève description de l'argument
- $required: est-ce nécessaire ?
addOption()
- addOption($name, $description, $required=false, $withArg=false, $shortName=false);
- $required: le paramètre est-il requis ?
- $withArg: un argument est-il requis avec cette option ?
- $shortName: caractère à utiliser comme nom court
Le nom court sera, par exemple 'm' si vous voulez que -mFast soit une alternative pour --mode=Fast.
getArg()
- getArg( $argId = 0, $default = null );
- $argId: valeur entière (à partir de zéro) de l'argument
- $default: valeur par défaut si elle n'existe pas
getOption()
- getOption( $name, $default = null );
- $name: le nom du parametre
- $default: défaut
outPut()
- output( $output, $channel = null );
runChild()
- runChild( $maintClass, $classFile = null );
- maintClass: nom d'une classe de maintenance fille
- $classFile: chemin complet de la classe fille