Du bist hier: Tips » Scripte » PHP
PHP
Referenzliste

getopt

PHP-Informationen

    Befehl:
array getopt ( string $options [, array $longopts ] )


    Parameter-Liste:
NameBeschreibung
optionsJeder Charakter in diesem String wird als Option-Zeichen verwendet und gegen Optionen, um das Skript übergeben, die mit einem Bindestrich angepasst werden (-). Zum Beispiel eine Option Zeichenfolge "x" erkennt eine Option--x. Nur a-z, A-Z und 0-9 sind erlaubt.
longoptsEine Reihe von Optionen. Jedes Element in diesem Array wird als Option Strings verwendet und gegen Optionen, um das Skript übergeben, beginnend mit zwei Bindestrichen angepasst werden (--). Zum Beispiel kann ein longopts Element "opt" erkennt eine Option --opt.
Der Parameter-options können die folgenden Elemente enthalten:
  • Einzelne Zeichen (keine Werte annehmen)
  • Zeichen, gefolgt von einem Doppelpunkt (Parameter erfordert Wert)
  • Charaktere von zwei Doppelpunkten (optional Wert), gefolgt
Option Werte sind das erste Argument nach dem String. Es spielt keine Rolle, ob ein Wert Leerzeichen führenden oder nicht.

Hinweis:
options Werte nicht akzeptieren " " (Leerzeichen) als Trenn.
Hinweis:
Das Format für die Optionen und longopts ist fast das gleiche, der einzige Unterschied ist, dass longopts nimmt ein Array von Optionen (wobei jedes Element die Option), während die options nimmt einen String (wobei jedes Zeichen ist die Option).

    Rückgabewerte:
Diese Funktion wird eine Reihe von Option / Argument-Paare im Fehlerfall FALSE zurück.
Hinweis:
Das Parsen der Optionen wird bei der ersten nicht-Option gefunden zu beenden, alles, was folgt, wird verworfen.

    Beschreibung:
Analysiert Optionen an das Skript übergebenen.


    Aktiv in Version:
(PHP 4 >= 4.3.0, PHP 5, PHP 7)

    Hinweis:
Hinweis: Optional Werte nicht akzeptieren " " (Leerzeichen) als Trennzeichen.

Das Format für die Optionen und longopts ist fast das gleiche, der einzige Unterschied ist, dass longopts eine Reihe von Optionen (wobei jedes Element die Option ist) nimmt während Optionen nimmt einen String (wobei jedes Zeichen die Option).

    Siehe auch:
•  $argv
Array der an das Skript übergebenen Argumente
 

getopt() - Beispiel:


Eingabe:
<?php
$options = getopt("f:hp:");
var_dump($options);
?>


Ausgabe:
array(2) {
  ["f"]=>
  string(5) "value"
  ["h"]=>
  bool(false)
}

Beschreibung:
Version Beschreibung
5.3.0 Zusätzliche Unterstützung für die "=" als Argument / Wert-Separator.
5.3.0 Unterstützung für optionale Werte (angegeben mit "::").
5.3.0 Parameter longopts ist auf allen Systemen verfügbar.
5.3.0 Diese Funktion ist nicht mehr abhängig vom System, und jetzt funktioniert auf Windows, auch.
getopt() - Beispiel 2:


Eingabe:
<?php
$shortopts  = "";
$shortopts .= "f:";  // Required value
$shortopts .= "v::"; // Optional value
$shortopts .= "abc"; // These options do not accept values

$longopts  = array(
    "required:",     // Required value
    "optional::",    // Optional value
    "option",        // No value
    "opt",           // No value
);
$options = getopt($shortopts, $longopts);
var_dump($options);
?>


Ausgabe:
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)
}

Beschreibung:
Version Beschreibung
5.3.0 Zusätzliche Unterstützung für die "=" als Argument / Wert-Separator.
5.3.0 Unterstützung für optionale Werte (angegeben mit "::").
5.3.0 Parameter longopts ist auf allen Systemen verfügbar.
5.3.0 Diese Funktion ist nicht mehr abhängig vom System, und jetzt funktioniert auf Windows, auch.
getopt() - Beispiel 3:


Eingabe:
<?php
$options = getopt("abc");
var_dump($options);
?>


Ausgabe:
array(2) {
  ["a"]=>
  array(3) {
    [0]=>
    bool(false)
    [1]=>
    bool(false)
    [2]=>
    bool(false)
  }
  ["c"]=>
  bool(false)
}

Beschreibung:
Version Beschreibung
5.3.0 Zusätzliche Unterstützung für die "=" als Argument / Wert-Separator.
5.3.0 Unterstützung für optionale Werte (angegeben mit "::").
5.3.0 Parameter longopts ist auf allen Systemen verfügbar.
5.3.0 Diese Funktion ist nicht mehr abhängig vom System, und jetzt funktioniert auf Windows, auch.
PHP-Informationen