extract() 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
.
Note : Depuis la version 4.0.5, extract() retourne le nombre de variables extraites.
Note : EXTR_IF_EXISTS et EXTR_PREFIX_IF_EXISTS ont été introduites en PHP version 4.2.0.
Note : 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 :
Lors d'une collision, réécrire la variable existante.
Lors d'une collision, ne pas réécrire la variable existante.
Lors d'une collision, ajouter le préfixe prefix
,
et créer une nouvelle variable.
Ajouter le préfixe prefix
pour toutes les variables.
À partir de la version 4.0.5, les variables numériques sont aussi préfixées.
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.
É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.
Cette option a été ajoutée en PHP 4.2.0.
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.
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
.
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. Les préfixes sont
automatiquement séparés de l'index du tableau par un caractère de
soulignement.
extract() retourne le nombre de variables réellement importées dans la table des symboles.
Avertissement |
N'utilisez pas extract() sur des données inconnues, comme
les données utilisateurs ( |
Une utilisation possible de la fonction extract() est l'exportation vers la table des symboles de tableaux de variables retournés par wddx_deserialize().
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().
Précédent | Sommaire | Suivant |
end | Niveau supérieur | in_array |