13.3.5 ApiUsage::addOptionalParameter()
13.3.5.1 Description
string addOptionalParameter ( string $argName, string $argDefinition, string[]|callable $restriction = null, string $default = null )
La présence du paramètre est vérifiée et sa valeur retournée.
13.3.5.1.1 Avertissements
Aucun.
13.3.5.2 Liste des paramètres
- (string)
argName - Le nom du paramètre.
- (string)
argDefinition - Un texte (simple ligne) de description du paramètre.
- (string[]|callable)
restriction -
Liste des valeurs possibles pour le paramètre ou un callable vérifiant une contrainte à appliquer à la valeur du paramètre.
Si la restriction est un
array, alors la valeur passée doit obligatoirement être scalaire, et sa valeur doit être parmi les valeurs du tableau.Pour une autre restriction, se reporter à la description du callable de restriction.
- (string)
default - Valeur retournée par défaut si le paramètre n'est pas présent.
13.3.5.3 Valeur de retour
Si le paramètre est présent, alors la valeur du paramètre est retournée.
Si le paramètre n'est pas présent et qu'une valeur par défaut est fournie, alors
c'est la valeur par défaut qui est retournée, sinon null est retourné.
Si la valeur n'est pas conforme à la restriction spécifiée au moyen du paramètre
restriction, alors la validation est mise en erreur.
13.3.5.4 Erreurs / Exceptions
Aucune.
13.3.5.5 Historique
- Remplace la méthode
addOption()qui est dépréciée depuis la version 3.2.5.
13.3.5.6 Exemples
Définition du paramètre format :
$usage = new ApiUsage(); $format = $usage->addOptionalParameter('format', 'Paper format', array('a3', 'a4'), 'a4'); $usage->verify(); printf("format = '%s'\n", $format);
Chaîne d'usage générée :
$ ./wsh.php --api=test --help
Usage :
Options:
--userid=<user system id or login name to execute function - default is (admin)>, default is '1'
--format=<Paper format> [a3|a4], default is 'a4'
--help (Show usage)
Valeur par défaut :
$ ./wsh.php --api=test format = 'a4'
Passage de la valeur :
$ ./wsh.php --api=test --format=a3 format = 'a3'
13.3.5.7 Notes
Aucune.