(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
getopt — Lit des options passées dans la ligne de commande
getopt() lit les options passées dans la ligne de commande.
short_options-).
Par exemple, une chaîne optionnelle "x" correspondra
à l'option -x.
Seuls a-z, A-Z et 0-9 sont autorisés.
long_options--).
Par exemple, un élément longopts "opt"
correspondra à l'option --opt.
rest_indexrest_index est présent, alors l'index
où l'analyse des arguments s'est arrêtée sera écrit dans cette variable.
Le paramètre short_options peut contenir les éléments suivants :
Note: Les valeurs optionnelles n'acceptent pas l'espace comme séparateur.
Le tableau de valeurs long_options peut contenir :
Note:
Le format des paramètres
short_optionsetlong_optionsest identique ; la seule différence est quelong_optionsprend un tableau en option (où chaque élément est une option) alors queshort_optionsprend une chaîne (où chaque caractère est une option).
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é.
| Version | Description |
|---|---|
| 7.1.0 |
Ajout du paramètre rest_index.
|
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)
}
Exemple #4 Exemple de getopt() : Utilisant rest_index
<?php
// Script example.php
$rest_index = null;
$opts = getopt('a:b:', [], $rest_index);
$pos_args = array_slice($argv, $rest_index);
var_dump($pos_args);shell> php example.php -a 1 -b 2 -- test
L'exemple ci-dessus va afficher :
array(1) {
[0]=>
string(4) "test"
}