Manuel:Maintenance.php

This page is a translated version of the page Manual:Maintenance.php and the translation is 100% complete.

La classe Maintenance correspond à la classe abstraite maintenance pour écrire rapidement et créer des 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

Voir aussi