13.3 Classe ApiUsage

La classe ApiUsage gère la définition et la validation des paramètres lors l'appel et l'exécution de scripts CLI.

Elle permet de spécifier et contrôler la présence de paramètres requis ou optionnels, et de retourner un texte d'aide précisant les paramètres requis lorsque la validation échoue.

13.3.1 Constructeur

new ApiUsage ( Action & $action )

13.3.1.1 Liste des paramètres

(Action) action: L'objet $action courant.

13.3.1.2 Exemples

global $action;
 
$usage = new ApiUsage($action);
$docId = $usage->addRequiredParameter("id", "document id");
$usage->verify();
 
doSomeThingWith($docId);

$ ./wsh.php --api=test
Erreur : {CORE0001} argument 'id' expected
 
 
Usage :
        --id=<document id>
   Options:
        --userid=<user system id or login name to execute function - default is (admin)>, default is '1'
        --help (Show usage)

13.3.1.3 Notes

Aucune.

13.3.1.4 Voir aussi

Aucun.

Contenu du chapitre

13.3.2 ApiUsage::addEmptyParameter() nouveauté
13.3.3 ApiUsage::addHiddenParameter() nouveauté
13.3.4 ApiUsage::addRequiredParameter() nouveauté
13.3.5 ApiUsage::addOptionalParameter() nouveauté
13.3.6 ApiUsage::setDefinitionText() nouveauté
13.3.7 ApiUsage::setStrictMode()
13.3.8 ApiUsage::verify()

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