getopt

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

getopt — Lit des options passées dans la ligne de commande

Description

getopt() lit les options passées dans la ligne de commande.

Liste de paramètres

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)

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)

Note:

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).

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

Exemples

Exemple #1 Exemple avec getopt() : les bases

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

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

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

shell> php example.php -a 1 -b 2 -- test

L'exemple ci-dessus va afficher :

array(1) {
  [0]=>
  string(4) "test"
}

Voir aussi

• $argv