13.3.6 ApiUsage::setDefinitionText()

Ajoute un texte de description du script d'API dans le message d'usage.

13.3.6.1 Description

void setDefinitionText ( string $text )

13.3.6.1.1 Avertissements

Aucun.

13.3.6.2 Liste des paramètres

(string) text: Le texte (simple ligne) de description du script.

13.3.6.3 Valeur de retour

La méthode ne retourne pas de valeur.

13.3.6.4 Erreurs / Exceptions

Aucune.

13.3.6.5 Historique

Remplace la méthode setText() qui est dépréciée depuis la version 3.2.5.

13.3.6.6 Exemples

$usage = new ApiUsage();
$usage->setDefinitionText("Script de test de la classe ApiUsage");
$usage->verify();

$ ./wsh.php --api=test --help
Script de test de la classe ApiUsage
Usage :
   Options:
        --userid=<user system id or login name to execute function - default is (admin)>, default is '1'
        --help (Show usage)

13.3.6.7 Notes

Aucune.

13.3.6.8 Voir aussi

apiUsage::verify()

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