13.3.3 ApiUsage::addHiddenParameter()

13.3.3.1 Description

string addHiddenParameter ( string $argNAme, string $argDefinition = "" )

La présence du paramètre est vérifiée et sa valeur retournée.

Un paramètre hidden n'est pas requis, et il est traité comme un paramètre optionnel (ApiUsage::addOptionalParameter).

13.3.3.1.1 Avertissements

N/A

13.3.3.2 Liste des paramètres

(string) argName

Le nom du paramètre.

(string) argDefinition

Un texte (simple ligne) de description du paramètre.

13.3.3.3 Valeur de retour

Retourne la valeur du paramètre ou null si le paramètre n'est pas présent.

13.3.3.4 Erreurs / Exceptions

N/A

13.3.3.5 Historique

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

13.3.3.6 Exemples

$usage = new ApiUsage();
$hidden = $usage->addHiddenParameter("hidden", "Hidden option");
$usage->verify();
 
printf("hidden = '%s'\n", $hidden);

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

L'utilisation du paramètre --hidden n'apparaît pas dans le texte d'usage.

$ ./wsh.php --api=test --hidden=foo
hidden = 'foo'

13.3.3.7 Notes

N/A

13.3.3.8 Voir aussi

• ApiUsage::addOptionalParameter
• apiUsage::verify()