extractImporte les variables dans la table des symboles
&reftitle.description;
intextractarrayvar_arrayintextract_typeEXTR_OVERWRITEstringprefix
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.
&reftitle.parameters;
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
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 prefix pour 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
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.
&reftitle.returnvalues;
Retourne le nombre de variables importées avec succès dans la table
des symboles.
&reftitle.changelog;
&Version;&Description;4.3.0EXTR_REFS a été ajouté.
4.2.0EXTR_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.
&reftitle.examples;
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.
"blue",
"size" => "medium",
"shape" => "sphere");
extract($var_array, EXTR_PREFIX_SAME, "wddx");
echo "$color, $size, $shape, $wddx_size\n";
?>
]]>
&example.outputs;
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.
&reftitle.notes;
N'utilisez pas extract sur des données inconnues, comme
les données utilisateurs ($_GET, 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;.
&reftitle.seealso;
compact