extract
(PHP 4, PHP 5)
extract — Importe les variables dans la table des symboles
Description
&$array
[, int $flags = EXTR_OVERWRITE
[, string $prefix = NULL
]] )Importe les variables dans la table des symboles.
extract() vérifie chaque clé afin de contrôler si elle a un nom de variable valide. Elle vérifie également les collisions avec des variables existantes dans la table des symboles.
Liste de paramètres
-
array -
Un tableau associatif. Cette fonction crée les variables dont les noms sont les index de ce tableau, et leur affecte la valeur associée. Pour chaque paire clé/valeur, extract() crée une variable, avec les paramètres
flagsetprefix.Vous devez utiliser un tableau associatif. Un tableau indexé numériquement ne produira aucun résultat, à moins que vous n'utilisiez l'option
EXTR_PREFIX_ALLouEXTR_PREFIX_INVALID. -
flags -
Le traitement des collisions est déterminé par
flags. Ce paramètre peut prendre une des valeurs suivantes :-
EXTR_OVERWRITE - Lors d'une collision, réécrire la variable existante.
-
EXTR_SKIP - Lors d'une collision, ne pas réécrire la variable existante.
-
EXTR_PREFIX_SAME -
Lors d'une collision, ajouter le préfixe
prefix, et créer une nouvelle variable. -
EXTR_PREFIX_ALL -
Ajouter le préfixe
prefixpour toutes les variables. -
EXTR_PREFIX_INVALID -
Préfixer uniquement les variables aux noms invalides ou numériques
avec le préfixe
prefix. -
EXTR_IF_EXISTS - Écrase la variable uniquement si elle existe déjà dans la table des symboles, et, sinon, ne rien faire. Ceci est pratique pour définir une liste de variables valides, puis extraire du tableau les valeurs que vous avez déjà définies grâce à $_REQUEST, par exemple.
-
EXTR_PREFIX_IF_EXISTS - Ne crée que des variables préfixées, si la version non préfixée de la même variable existe dans la table des symboles courante.
-
EXTR_REFS -
Extrait les variables sous forme de références. Cela signifie que
les valeurs des variables importées font toujours référence aux
valeurs des variables d'origine dans le paramètre
array. Vous pouvez utiliser cette option seule, ou bien la combiner avec d'autres options avec l'opérateur OR, dans le paramètreflags.
Si
flagsest omis, extract() utiliseraEXTR_OVERWRITEpar défaut. -
-
prefix -
Notez que
prefixn'est nécessaire que pour les valeurs deflagssuivantes :EXTR_PREFIX_SAME,EXTR_PREFIX_ALL,EXTR_PREFIX_INVALIDouEXTR_PREFIX_IF_EXISTS. Si le résultat préfixé n'est pas un nom de variable valide, il ne sera pas importé dans la table des symboles. Les préfixes sont automatiquement séparés de l'index du tableau par un caractère de soulignement.
Valeurs de retour
Retourne le nombre de variables importées avec succès dans la table des symboles.
Exemples
Exemple #1 Exemple avec extract()
Une utilisation possible de la fonction extract() est l'exportation vers la table des symboles de tableaux de variables retournés par wddx_deserialize().
<?php
/* Supposons que $var_array est un tableau retourné par
wddx_deserialize */
$size = "large";
$var_array = array("color" => "blue",
"size" => "medium",
"shape" => "sphere");
extract($var_array, EXTR_PREFIX_SAME, "wddx");
echo "$color, $size, $shape, $wddx_size\n";
?>
L'exemple ci-dessus va afficher :
blue, large, sphere, medium
La variable $size n'a pas été réécrite, car on
avait spécifié le paramètre EXTR_PREFIX_SAME,
qui a permis la création de $wddx_size. Si
EXTR_SKIP avait été utilisée, alors
$wddx_size n'aurait pas été créé.
Avec EXTR_OVERWRITE, $size
aurait pris la valeur "medium", et avec EXTR_PREFIX_ALL,
les variables créées seraient $wddx_color,
$wddx_size et $wddx_shape.
Notes
N'utilisez pas extract() sur des données inconnues, comme
les données utilisateurs (i.e. $_GET,
$_FILES, etc.).
Si vous le faites, par exemple, pour rendre compatible un vieux code avec
register_globals
à Off de façon temporaire, assurez-vous d'utiliser l'une des constantes
flags qui n'écrasent pas les valeurs, comme
EXTR_SKIP. Sachez aussi que vous devez maintenant
extraire dans le même ordre que celui défini dans variables_order du php.ini.
Note:
Si vous avez la directive register_globals d'activée et que vous utilisez la fonction extract() sur les variables $_FILES et que vous spécifiez la constante
EXTR_SKIP, vous pourriez être surpris du résultat.AvertissementCette façon de faire n'est pas recommandée et est uniquement documentée ici pour bien comprendre le comportement. L'utilisation de la directive register_globals est obsolète et appeler la fonction extract() sur des données partagées comme les variables $_FILES est, comme mentionné ci-dessus, un risque potentiel pour la sécurité. Si vous rencontrez ce problème, cela signifie que vous avez écrit votre code de la mauvaise manière pour au moins 2 raisons.
Vous vous attendez à voir quelque chose comme :<?php
/* Supposez que $testfile est le nom d'un champ de téléchargement de fichier
et que register_globals est actif. */
var_dump($testfile);
extract($_FILES, EXTR_SKIP);
var_dump($testfile);
var_dump($testfile['tmp_name']);
?>Cependant, vous devriez plutôt voir quelque comme :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"string(14) "/tmp/phpgCCPX8" string(14) "/tmp/phpgCCPX8" string(1) "/"Ceci est dû au fait que, depuis que la directive register_globals est active, la variable $testfile existe déjà dans le scope global lorsque la fonction extract() est appelée. Et vû que la constante
EXTR_SKIPest spécifiée, la variable $testfile n'est pas écrasée avec le contenu du tableau$_FILES, aussi, la variable $testfile reste une chaîne de caractères. Parceque les chaînes de caractères peuvent être accédées en utilisant la syntaxe des tableaux et que la chaîne de caractères non-numérique tmp_name est interprétée comme 0, PHP voit $testfile['tmp_name'] comme $testfile[0].