13.3.2 ApiUsage::addEmptyParameter()

13.3.2.1 Description

mixed addEmptyParameter ( string $argName, string $argDefinition = "" )

13.3.2.1.1 Avertissements

Aucun.

13.3.2.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.2.3 Valeur de retour

Si le paramètre est présent dans les arguments, alors une chaîne vide est retournée, sinon false est retourné.

13.3.2.4 Erreurs / Exceptions

Aucune.

13.3.2.5 Historique

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

13.3.2.6 Exemples

$usage = new ApiUsage();
$debug = $usage->addEmptyParameter("debug", "Turn on debug messages.");
$usage->verify();
 
$debug = ($debug === false) ? false : true;
 
if ($debug) {
    printf("Debug mode ON\n");
} else {
    printf("Debug mode OFF\n");
}

$ ./wsh.php --api=sampleApi
Debug mode OFF

Le paramètre n'est pas présent.

$ ./wsh.php --api=sampleApi --debug
Debug mode ON

Le paramètre est présent.

13.3.2.7 Notes

Aucune.

13.3.2.8 Voir aussi

• apiUsage::verify()