13.3.8 ApiUsage::verify()

13.3.8.1 Description

void verify ( bool $useException = false )

Lance la validation des paramètres précédemment définis et génère une erreur si les paramètres ne sont pas conformes.

13.3.8.1.1 Avertissements

Aucun.

13.3.8.2 Liste des paramètres

(bool) useException

Active (true) ou désactive (false) la remontée d'erreur par exception lors de l'échec de la validation des paramètres.

13.3.8.3 Valeur de retour

Aucune.

13.3.8.4 Erreurs / Exceptions

Par défaut, l'erreur est remontée via un appel à Action::exitError.

Si le mode de remontée d'erreur par exception est actif, alors une exception \Dcp\ApiUsage\Exception est levée.

13.3.8.5 Historique

Aucun.

13.3.8.6 Exemples

$usage = new ApiUsage();
try {
    $usage->verify(true);
} catch(\Dcp\ApiUsage\Exception $e) {
    printf("Bad parameters!\n");
}
printf("Done.");

$ ./wsh.php --api=test --foo=bar
Bad parameters!
Done.

13.3.8.7 Notes

Aucune.

13.3.8.8 Voir aussi

Aucun.