13.2.2 ActionUsage::getUsage()

Retourne le texte d'aide d'usage.

13.2.2.1 Description

string getUsage ()

Le texte d'aide retourné est un texte multi-ligne avec le retour chariot Unix (\n) comme séparateur de lignes.

13.2.2.1.1 Avertissements

Aucun.

13.2.2.2 Liste des paramètres

Aucun.

13.2.2.3 Valeur de retour

Le message texte d'aide d'usage sur plusieurs lignes.

13.2.2.4 Erreurs / Exceptions

Aucune.

13.2.2.5 Historique

Aucun.

13.2.2.6 Exemples

function myaction1( Action & $action ) {
    $usage = new ActionUsage($action);
 
    $usage->setDefinitionText("Sample action");
    $docid = $usage->addRequiredParameter(
        "id",
        "Document id"
    );
    $format = $usage->addOptionalParameter(
        "format",
        "Paper format",
        array(
            "a3",
            "a4",
            "a5"
        ),
        "a4"
    );
    $usage->verify();
    ...
}

Web :

.-------------------------------------------------------------------.
|   .-------------.                                                 |
|  /  Erreur    x  \                                                |
|-'                 '-----------------------------------------------|
| [ http://localhost/?app=MYAPP&action=MYACTION1 ________________ ] |
|-------------------------------------------------------------------|
|                                                                   |
|  .-------------------------------------------------------------.  |
|  | argument 'id' expected                                      |  |
|  |                                                             |  |
|  |                                                             |  |
|  | Sample action                                               |  |
|  |                                                             |  |
|  | Usage :                                                     |  |
|  |                                                             |  |
|  |          &app=MYAPP : <application name>                    |  |
|  |                                                             |  |
|  |          &action=MYACTION1 : <action name>                  |  |
|  |                                                             |  |
|  |          &id=<Document id>                                  |  |
|  |                                                             |  |
|  |     Options:                                                |  |
|  |                                                             |  |
|  |          &format=<Paper format> [a3|a4|a5], default is 'a4' |  |
|  '-------------------------------------------------------------'  |
|                                                                   |
|                                                                   |
'-------------------------------------------------------------------'

CLI :

$ ./wsh.php --app=MYAPP --action=MYACTION1
Erreur : {CORE0001} argument 'id' expected
 
Sample action
Usage :
        --app=MYAPP : <application_name>
        --action=MYACTION1 : <action_name>
        --id=<Document id>
    Options:
        --format=<Paper format> [a3|a4|a5], default is 'a4'

13.2.2.7 Notes

Aucune.

13.2.2.8 Voir aussi

ApiUsage

Source : API/Class_ActionUsage/Method_getUsage.md Dynacase Platform 3.2 | Core Manuel de référence, version 3.2 édition 13, © Anakeen Labs <labs@anakeen.com>