(PHP 4, PHP 5, PHP 7, PHP 8)
extract — Importe les variables dans la table des symboles
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.
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 flags
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
.
flags
Le traitement des collisions est déterminé par flags
. 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
array
. Vous pouvez utiliser cette option seule, ou bien la combiner avec d'autres options avec l'opérateur OR, dans le paramètre flags
. Si flags
est omis, extract() utilisera EXTR_OVERWRITE
par défaut.
prefix
Notez que prefix
n'est nécessaire que pour les valeurs de flags
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.
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
$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.
N'utilisez pas extract() sur des données inconnues, comme les données utilisateurs (i.e. $_GET, $_FILES, etc.). Si vous le faites, 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.