extract
Importe les variables dans la table des symboles
&reftitle.description;
intextractarrayvar_arrayintextract_typestringprefixextract sert à exporter un tableau vers
la table des symboles. Elle prend un tableau associatif
var_array, 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.
Depuis la version 4.0.5, extract retourne le nombre de
variables extraites.
EXTR_IF_EXISTS et EXTR_PREFIX_IF_EXISTS
ont été introduites en &php; version 4.2.0.
EXTR_REFS a été introduite en &php; 4.3.0.
extract vérifie l'existence de la variable avant
de la créer. 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.
A partir de la version 4.0.5, les variables numériques sont aussi préfixées.
EXTR_PREFIX_INVALID
Préfixer uniquement les variables aux noms invalides ou numériques
avec le préfixe prefix. Ceci a
été ajouté en &php; 4.0.5.
EXTR_IF_EXISTS
Ecrase 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
d'extraire du tableau les valeurs que vous avez déjà définies
grâce à $_REQUEST, par exemple.
Cette option a été ajoutée en &php; 4.2.0.
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.
Cette option a été ajoutée en &php; 4.2.0.
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 option avec
l'opérateur OR, dans le paramètre extract_type.
Cette option a été ajoutée en &php; 4.3.0.
Si extract_type est omis, extract
utilise EXTR_OVERWRITE par défaut.
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.
extract retourne le nombre de variables réellement
importées dans la table des symboles.
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 $_SERVER, $_SESSION,
$_COOKIE, $_POST et
$_GET dans cet ordre.
Une utilisation possible de la fonction extract est l'exportation
vers la table des symboles de tableaux de variables retournés
par wddx_deserialize.
Exemple avec extract
"bleu",
"taille" => "moyen",
"forme" => "sphere");
extract($var_array, EXTR_PREFIX_SAME, "wddx");
echo "$couleur, $taille, $forme, $wddx_taille\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.
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.
Voir aussi compact.