getoptLit des options passées dans la ligne de commande
&reftitle.description;
arrayfalsegetoptstringshort_optionsarraylong_options[]intrest_index&null;getopt lit les options passées dans la ligne de commande.
&reftitle.parameters;
short_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.
long_options
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.
rest_index
Si le paramètre rest_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 :
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)
Les valeurs optionnelles sont les premiers arguments après la chaîne. Si
une valeur est requise, peu importe que la valeur soit suivi d'un espace ou
non. Voir la note.
Les valeurs optionnelles n'acceptent pas l'espace comme séparateur.
Le tableau de valeurs long_options peut contenir :
String (paramètre n'accepte aucune valeur)String suivit d'un deux-point (paramètre nécessite une valeur)String suivit de deux deux-points (valeur optionnel)
Le format des paramètres short_options et
long_options est identique ; la seule différence est
que long_options prend un tableau en option (où chaque élément
est une option) alors que short_options prend une chaîne
(où chaque caractère est une option).
&reftitle.returnvalues;
Cette fonction retourne un tableau d'options/arguments, &return.falseforfailure;.
L'analyse des options s'arrêtera lorsque la première mauvaise
option sera trouvée, et tout ce qui suivra sera ignoré.
&reftitle.changelog;
&Version;&Description;7.1.0
Ajout du paramètre rest_index.
&reftitle.examples;
Exemple avec getopt : les bases
]]>
php example.php -fvalue -h
]]>
&example.outputs;
string(5) "value"
["h"]=>
bool(false)
}
]]>
Second exemple avec getopt : Introduction aux options longues
]]>
php example.php -f "value for f" -v -a --required value --optional="optional value" --option
]]>
&example.outputs;
string(11) "value for f"
["v"]=>
bool(false)
["a"]=>
bool(false)
["required"]=>
string(5) "value"
["optional"]=>
string(14) "optional value"
["option"]=>
bool(false)
}
]]>
Troisième exemple avec getopt : Passage de plusieurs options
]]>
php example.php -aaac
]]>
&example.outputs;
array(3) {
[0]=>
bool(false)
[1]=>
bool(false)
[2]=>
bool(false)
}
["c"]=>
bool(false)
}
]]>
Exemple de getopt : Utilisant rest_index
php example.php -a 1 -b 2 -- test
]]>
&example.outputs;
string(4) "test"
}
]]>
&reftitle.seealso;
$argv