extract

    (PHP 4, PHP 5, PHP 7, PHP 8)

    extract — Importiert Variablen eines Arrays in die aktuelle Symboltabelle

    Beschreibung

    extract(array&$array, int$flags = EXTR_OVERWRITE, string$prefix = ""): int

    Diese Funktion wird verwendet, um Variablen eines Arrays in die aktuelle Symboltabelle zu importieren.

    Jeder Schlüssel wird geprüft, ob er einen gültigen Variablennamen ergibt und ob es Kollisionen mit existierenden Variablen in der Symboltabelle gibt.

    Warnung

    Verwenden Sie extract() nicht für nicht vertrauenswürdige Daten wie Benutzereingaben (z. B. $_GET, $_FILES).

    Parameter-Liste

    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 flags 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ührt, außer Sie verwenden EXTR_PREFIX_ALL oder EXTR_PREFIX_INVALID.

    flags

    Die Art, wie ungültige/numerische Schlüssel und Kollisionen behandelt werden, wird durch flags 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 immer noch die Werte des Parameters array referenzieren. Sie können dieses Flag alleine oder auch in Kombination mit einem anderen Flag verwenden, indem Sie die flags mit OR verknüpfen.

    Ist flags nicht angegeben, so wird EXTR_OVERWRITE angenommen.

    prefix

    Beachten Sie, dass prefix nur dann nötig ist, wenn flagsEXTR_PREFIX_SAME, EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID oder 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 der erfolgreich in die Symboltabelle importierten Variablen zurück.

    Beispiele

    Beispiel #1 extract()-Beispiel

    Eine mögliche Verwendung für extract() ist, Variablen in die Symboltabelle zu importieren, die in einem von wddx_deserialize() zurückgegebenen assoziativen Array enthalten sind.

    <?php



    $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 angegeben haben. Das führte dazu, dass $wddx_groesse erstellt wurde. Mit der Angabe EXTR_SKIP wäre $wddx_groesse nicht erstellt 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 erstellt.

    Anmerkungen

    Warnung

    Verwenden Sie extract() nicht für nicht vertrauenswürdige Daten wie Benutzereingaben (d. h. $_GET, $_FILES, ...). Wenn Sie das tun, stellen Sie sicher, dass Sie einen der nicht überschreibenden flags-Werte wie z. B. EXTR_SKIP verwenden und beachten Sie, dass Sie die Daten in der selben Reihenfolge extrahieren müssen, die in variables_order in der php.ini angegeben wurde.

    Siehe auch

    • compact() - Erstellt ein Array mit Variablen und deren Werten
    • list() - Weist Variablen zu, als wären sie ein Array
    To Top