13.3.7 ApiUsage::setStrictMode()

13.3.7.1 Description

void setStrictMode ( bool $strict = true )

Lorsque le mode de validation strict est activé, la présence d'arguments non enregistrés auprès de l'instance d'ApiUsage en cours met en échec la validation des paramètres.

Par défaut, le mode de validation strict est actif.

13.3.7.1.1 Avertissements

Aucun.

13.3.7.2 Liste des paramètres

(bool) strict

Active ou désactive le mode de validation strict.

13.3.7.3 Valeur de retour

Aucune.

13.3.7.4 Erreurs / Exceptions

Aucune.

13.3.7.5 Historique

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

13.3.7.6 Exemples

$usage = new ApiUsage();
$usage->verify();

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

Une erreur est remontée concernant le paramètre foo inconnu.

$usage = new ApiUsage();
$usage->setStrictMode(false);
$usage->verify();

$ ./wsh.php --api=test --foo=bar

Aucune erreur n'est remonté concernant le paramètre foo inconnu.

13.3.7.7 Notes

Si l'action a pour vocation d'être appelée par une autre action, il est préférable de passer le mode strict à false pour ne pas déclencher d'erreur si l'action appelante n'a pas la même liste de paramètres.

13.3.7.8 Voir aussi

• apiUsage::verify()