(PHP 4, PHP 5)
extract — Importiert Variablen eines Arrays in die aktuelle Symboltabelle
Diese Funktion wird verwendet, um Variablen eines Arrays in die aktuelle Symboltabelle zu importieren.
Prüft jeden Schlüssel, ob dieser einen gültigen Variablennamen ergibt, und auch auf eventuelle Kollisionen mit existierenden Variablen in der Symboltabelle.
Ein assoziatives Array. Die Funktion behandelt Schlüssel als Variablennamen und Werte als Variablenwerte. Für jedes Paar Schlüssel/Wert wird - abhängig von den Parametern extract_type und prefix - eine Variable in der aktuellen Symboltabelle eingetragen.
Sie müssen ein assoziatives Array verwenden, da ein numerisch indiziertes Array zu keinem Ergebnis führen wird, außer Sie benutzen EXTR_PREFIX_ALL oder EXTR_PREFIX_INVALID.
The way invalid/numeric keys and collisions are treated is determined by the extract_type . It can be one of the following values:
Ist extract_type nicht spezifiziert, so wird EXTR_OVERWRITE angenommen.
Beachten Sie, dass prefix nur dann nötig ist, wenn extract_type EXTR_PREFIX_SAME, EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID or EXTR_PREFIX_IF_EXISTS ist. Ist das Resultat trotz Präfix kein gültiger Variablenname, wird es nicht in die Symboltabelle importiert. Präfixe werden automatisch mit einem Unterstrich vom Schlüssel des Arrays getrennt.
extract() gibt die Anzahl erfolgreich in die Symboltabelle importierter Variablen zurück.
| Version | Beschreibung |
|---|---|
| 4.3.0 | EXTR_REFS wurde hinzugefügt. |
| 4.2.0 | EXTR_IF_EXISTS und EXTR_PREFIX_IF_EXISTS wurden hinzugefügt. |
| 4.0.5 | Diese Funktion gibt jetzt die Anzahl der extrahierten Variablen zurück. EXTR_PREFIX_INVALID wurde hinzugefügt. EXTR_PREFIX_ALL schließt numerische Variablen ebenfalls ein. |
Beispiel #1 extract()-Beispiel
Eine mögliche Verwendung für extract() ist der Import der Variablen in einem von wddx_deserialize() gelieferten assoziativen Array in die Symboltabelle.
<?php
/* Annahme: $var_array ist ein von wddx_deserialize
zurückgegebenes Array */
$groesse = "groß";
$var_array = array("farbe" => "blau",
"groesse" => "mittel",
"form" => "Kugel");
extract($var_array, EXTR_PREFIX_SAME, "wddx");
echo "$farbe, $groesse, $form, $wddx_groesse\n";
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
blau, groß, Kugel, mittel
$size wurde nicht überschrieben, da wir EXTR_PREFIX_SAME spezifiziert haben, was im Anlegen von $wddx_size endete. Wäre EXTR_SKIP spezifiziert worden, dann wäre $wddx_size nicht angelegt worden. EXTR_OVERWRITE hätte $size mit dem Wert "medium" überschrieben, und EXTR_PREFIX_ALL hätte die neuen Variablen $wddx_color, $wddx_size, und $wddx_shape angelegt.
Verwenden Sie extract() nicht für nicht vertrauenswürdige Daten wie Benutzereingaben ($_GET, ...). Wenn Sie dies tun, z.B. weil Sie alten Code, der sich auf register_globals verlässt, vorübergehend ausführen wollen, so stellen Sie sicher, dass Sie einen nicht-überschreibenden extract_type -Wert wie EXTR_SKIP verwenden und seien Sie sich bewusst, dass Sie die Daten in der selben Reihenfolge importieren sollen, die in variables_order in der php.ini angegeben wurde.