getopt
(PHP 4 >= 4.3.0, PHP 5, PHP 7)
getopt — Lit des options passées dans la ligne de commande
Description
$options
[, array $longopts
] )getopt() lit les options passées dans la ligne de commande.
Liste de paramètres
-
options
- Chaque caractère dans cette chaîne sera utilisé en tant que caractères optionnels et devra correspondre aux options passées, commençant par un tiret simple (-). Par exemple, une chaîne optionnelle "x" correspondra à l'option -x. Seuls a-z, A-Z et 0-9 sont autorisés.
-
longopts
- Un tableau d'options. Chaque élément de ce tableau sera utilisé comme option et devra correspondre aux options passées, commençant par un tiret double (--). Par exemple, un élément longopts "opt" correspondra à l'option --opt.
Le paramètre options
peut contenir les éléments suivants :
- Caractères individuels (n'accepte pas de valeur)
- Caractères suivis par un deux-points (le paramètre nécessite une valeur)
- Caractères suivis par deux deux-points (valeur optionnelle)
Note: Les valeurs optionnelles n'acceptent pas l'espace comme séparateur.
Note:
Le format des paramètres
options
etlongopts
est identique ; la seule différence est quelongopts
prend un tableau en option (où chaque élément est une option) alors queoptions
prend une chaîne (où chaque caractère est une option).
Valeurs de retour
Cette fonction retourne un tableau d'options/arguments, ou FALSE
si une erreur survient.
Note:
L'analyse des options s'arrêtera lorsque la première mauvaise option sera trouvée, et tout ce qui suivra sera ignoré.
Historique
Version | Description |
---|---|
5.3.0 | Ajout du support de "=" comme séparateur argument/valeur. |
5.3.0 | Ajout du support des valeurs optionnelles (spécifié par "::"). |
5.3.0 |
Le paramètre longopts
est disponible sur tous les systèmes.
|
5.3.0 | Cette fonction n'est plus dépendante du système et fonctionne maintenant également sous Windows. |
Exemples
Exemple #1 Exemple avec getopt() : les bases
<?php
// Script example.php
$options = getopt("f:hp:");
var_dump($options);
?>
shell> php example.php -fvalue -h
L'exemple ci-dessus va afficher :
array(2) { ["f"]=> string(5) "value" ["h"]=> bool(false) }
Exemple #2 Second exemple avec getopt() : Introduction aux options longues
<?php
// Script example.php
$shortopts = "";
$shortopts .= "f:"; // Valeur requise
$shortopts .= "v::"; // Valeur optionnelle
$shortopts .= "abc"; // Ces options n'acceptent pas de valeur
$longopts = array(
"required:", // Valeur requise
"optional::", // Valeur optionnelle
"option", // Aucune valeur
"opt", // Aucune valeur
);
$options = getopt($shortopts, $longopts);
var_dump($options);
?>
shell> php example.php -f "value for f" -v -a --required value --optional="optional value" --option
L'exemple ci-dessus va afficher :
array(6) { ["f"]=> string(11) "value for f" ["v"]=> bool(false) ["a"]=> bool(false) ["required"]=> string(5) "value" ["optional"]=> string(14) "optional value" ["option"]=> bool(false) }
Exemple #3 Troisième exemple avec getopt() : Passage de plusieurs options
<?php
// Script example.php
$options = getopt("abc");
var_dump($options);
?>
shell> php example.php -aaac
L'exemple ci-dessus va afficher :
array(2) { ["a"]=> array(3) { [0]=> bool(false) [1]=> bool(false) [2]=> bool(false) } ["c"]=> bool(false) }
Document créé le 30/01/2003, dernière modification le 26/10/2018
Source du document imprimé : https://www.gaudry.be/php-rf-function.getopt.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.