(PHP 4, PHP 5)
extract — Importe les variables dans la table des symboles
&$var_array
[, int $extract_type = 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.
var_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 extract_type
et prefix.
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_ALL ou EXTR_PREFIX_INVALID.
extract_type
Le traitement des collisions est
déterminé par extract_type.
Ce paramètre peut prendre une des valeurs suivantes :
EXTR_OVERWRITE
EXTR_SKIP
EXTR_PREFIX_SAME
prefix,
et créer une nouvelle variable.
EXTR_PREFIX_ALL
prefix pour toutes les variables.
EXTR_PREFIX_INVALID
prefix.
EXTR_IF_EXISTS
EXTR_PREFIX_IF_EXISTS
EXTR_REFS
var_array. Vous pouvez utiliser cette
option seule, ou bien la combiner avec d'autres options avec
l'opérateur OR, dans le paramètre extract_type.
Si extract_type est omis, extract()
utilise EXTR_OVERWRITE par défaut.
prefix
Notez que prefix n'est nécessaire que pour
les valeurs de extract_type suivantes :
EXTR_PREFIX_SAME, EXTR_PREFIX_ALL,
EXTR_PREFIX_INVALID ou EXTR_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.
Retourne le nombre de variables importées avec succès dans la table des symboles.
| Version | Description |
|---|---|
| 4.3.0 |
EXTR_REFS a été ajouté.
|
| 4.2.0 |
EXTR_IF_EXISTS et EXTR_PREFIX_IF_EXISTS
ont été ajoutés.
|
| 4.0.5 |
Cette fonction retourne maintenant le nombre de variables extraites.
EXTR_PREFIX_INVALID a été ajouté.
EXTR_PREFIX_ALL inclut également les variables numériques.
|
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 $taille 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_taille. Si
EXTR_SKIP avait été utilisée, alors
$wddx_taille n'aurait pas été créé.
Avec EXTR_OVERWRITE, $taille
aurait pris la valeur "moyen", et avec EXTR_PREFIX_ALL,
les variables créées seraient $wddx_couleur,
$wddx_taille et $wddx_forme.
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
extract_type 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].