end
in_array
Array Funktionen
PHP Manual

# extract

(PHP 4, PHP 5)

extract — Importiert Variablen eines Arrays in die aktuelle Symboltabelle

### Beschreibung

int extract ( array `$var_array` [, int `$extract_type` = EXTR_OVERWRITE [, string `$prefix` ]] )

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.

### Parameter-Liste

`var_array`

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

`extract_type`

  Die Art, wie ungültige/numerische Schlüssel und Kollisionen behandelt werden, wird durch `extract_type` bestimmt. Die folgenden Werte sind erlaubt:

  `EXTR_OVERWRITE`
    Im Falle einer Kollision wird die existierende Variable überschrieben.
  `EXTR_SKIP`
    Im Falle einer Kollision wird die existierende Variable nicht überschrieben.
  `EXTR_PREFIX_SAME`
    Im Falle einer Kollision wird dem Variablennamen `prefix` vorangestellt.
  `EXTR_PREFIX_ALL`
    Allen Variablennamen wird `prefix` vorangestellt.
  `EXTR_PREFIX_INVALID`
    Nur ungültigen/numerischen Variablennamen wird `prefix` vorangestellt.
  `EXTR_IF_EXISTS`
    Überschreibt die Variable nur, wenn sie bereits in der aktuellen Symboltabelle existiert, sonst geschieht nichts. Dies ist dann hilfreich, wenn Sie eine Liste mit gültigen Variablen definieren, und dann z.B. nur jene Variablen extrahieren, welche Sie aus $_REQUEST definiert haben.
  `EXTR_PREFIX_IF_EXISTS`
    Erstellt nur Variablennamen mit Präfix, wenn die Version ohne Präfix der selben Variable in der aktuellen Symboltabelle existiert.
  `EXTR_REFS`
    Extrahiert Variablen als Referenzen. Das heißt, dass die Werte der importierten Variablen noch immer auf die Werte des Parameters `var_array` referenzieren. Sie können diesen Flag alleine oder auch in Kombination mit einem anderen Flag verwenden, indem Sie Oder-Verknüpfungen im `extract_type` erstellen.

  Ist `extract_type` nicht spezifiziert, so wird `EXTR_OVERWRITE` angenommen.

`prefix`

  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.

### Rückgabewerte

extract() gibt die Anzahl erfolgreich in die Symboltabelle importierter Variablen zurück.

### Changelog

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.

### Beispiele

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

$groesse wurde nicht überschrieben, da wir `EXTR_PREFIX_SAME` spezifiziert haben, was im Anlegen von $wddx_groesse endete. Wäre `EXTR_SKIP` spezifiziert worden, dann wäre $wddx_groesse nicht angelegt worden. `EXTR_OVERWRITE` hätte $groesse mit dem Wert "mittel" überschrieben, und `EXTR_PREFIX_ALL` hätte die neuen Variablen $wddx_farbe, $wddx_groesse, und $wddx_form angelegt.

### Anmerkungen

Warnung

Verwenden Sie extract() nicht für nicht vertrauenswürdige Daten wie Benutzereingaben (d.h. $_GET, $_FILES, ...). 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.

> Hinweis: Wenn Sie register_globals aktiviert haben, Sie extract() auf $_FILES anwenden und Sie `EXTR_SKIP` angeben, könnten Sie über das Ergebnis überrascht sein.

> Warnung

> Dies ist keine empfohlene Vorgehensweise; es ist nur der Vollständigkeit halber hier dokumentiert. Die Nutzung von register_globals wird nicht mehr empfohlen und das Aufrufen von extract() auf nicht vertrauenswürdigen Daten wie $_FILES ist, wie oben beschrieben, ein potenzielles Sicherheitsrisiko. Wenn Sie auf dieses Ergebnis stoßen, bedeutet das, dass Sie mindestens zwei schlechte Codierungs-Praktiken benutzen.

> `<?php
> /* Annahmen: $testfile ist der Name einer hochgeladenen Datei,
> register_globals ist aktiviert */
> var_dump($testfile);
> extract($_FILES, EXTR_SKIP);
> var_dump($testfile);
> var_dump($testfile['tmp_name']);
> ?>`
> Sie werden wahrscheinlich folgende Ausgabe erwarten:

>     string(14) "/tmp/phpgCCPX8"
>     array(5) {
>       ["name"]=>
>       string(10) "somefile.txt"
>       ["type"]=>
>       string(24) "application/octet-stream"
>       ["tmp_name"]=>
>       string(14) "/tmp/phpgCCPX8"
>       ["error"]=>
>       int(0)
>       ["size"]=>
>       int(4208)
>     }
>     string(14) "/tmp/phpgCCPX8"

> Stattdessen erhalten Sie aber eine Ausgabe wie diese:

>     string(14) "/tmp/phpgCCPX8"
>     string(14) "/tmp/phpgCCPX8"
>     string(1) "/"

> Dies liegt daran, dass aufgrund der Aktivierung von register_globals $testfile bereits im globalen Scope existiert, wenn extract() aufgerufen wird. Da `EXTR_SKIP` angegeben wurde, wird $testfile nicht mit den Inhalten des `$_FILES`-Arrays überschrieben und somit bleibt $testfile ein String. Da auf Strings über die Array-Syntax zugegriffen werden kann und der nicht-numerische String tmp_name als 0 interpretiert wird, versteht PHP $testfile['tmp_name'] als $testfile[0].

### Siehe auch

- compact() - Erstellt ein Array mit Variablen und deren Werten

end
in_array
Array Funktionen
PHP Manual