PHP extract()Funciones

PHP Array ReferenceManual de referencia completo de PHP Array

Ejemplos

Asignar los valores de las claves "Cat", "Dog" y "Horse" a las variables $a, $b y $c:

<?php $a = "Original"; $my_array = array("a" => "Cat","b" => "Dog", "c" => "Horse"); extract($my_array); echo "\$a = $a; \$b = $b; \$c = $c"; ?>

Ejecutar ejemplo »

Definición y uso

La función extract() importa variables desde un array a la tabla de símbolos actual.

Esta función utiliza los nombres de las claves del array como nombres de variables y los valores de las claves como valores de las variables. Para cada elemento del array, se creará una variable correspondiente en la tabla de símbolos actual.

Esta función devuelve el número de variables establecidas con éxito.

Sintaxis

extract(array,extract_rules,prefix)

Parámetros Descripción
array Obligatorio. Especifica el array que se va a utilizar.
extract_rules Opcional. La función extract() comprobará si cada nombre de clave es un nombre de variable válido y también comprobará si hay conflictos con los nombres de variables ya existentes en la tabla de símbolos. El tratamiento de los nombres de clave no válidos o en conflicto se determinará según este parámetro.

Valores posibles:

  • EXTR_OVERWRITE - Por defecto. Si hay conflicto, sobrescribe la variable existente.
  • EXTR_SKIP - Si hay conflicto, no sobrescribe la variable existente.
  • EXTR_PREFIX_SAME - Si hay conflicto, antepone el prefijo prefix al nombre de la variable.
  • EXTR_PREFIX_ALL - Antepone el prefijo prefix a todos los nombres de variables.
  • EXTR_PREFIX_INVALID - Antepone el prefijo prefix solo a nombres de variables no válidos o numéricos.
  • EXTR_IF_EXISTS - Solo sobrescribe los valores si ya existe una variable con el mismo nombre en la tabla de símbolos actual. Las demás no se procesan.
  • EXTR_PREFIX_IF_EXISTS - Solo crea nombres de variables con el prefijo añadido si ya existe una variable con el mismo nombre en la tabla de símbolos actual. Las demás no se procesan.
  • EXTR_REFS - Extrae las variables como referencias. Las variables importadas siguen haciendo referencia a los valores del parámetro array.
prefix Opcional. Si el valor del parámetro extract_rules es EXTR_PREFIX_SAME, EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID o EXTR_PREFIX_IF_EXISTS, entonces prefix es obligatorio.

Este parámetro especifica el prefijo. Se añadirá automáticamente un guion bajo entre el prefijo y el nombre de la clave del array.

Detalles técnicos

Valor de retorno: Devuelve el número de variables establecidas con éxito.
Versión de PHP: 4+
Registro de cambios: extract_rulesEl valor EXTR_REFS se añadió en PHP 4.3.

extract_rulesLos valores EXTR_IF_EXISTS y EXTR_PREFIX_IF_EXISTS se añadieron en PHP 4.2.

Desde PHP 4.0.5, esta función devuelve el número de variables establecidas con éxito.

extract_rulesEl valor EXTR_PREFIX_INVALID se añadió en PHP 4.0.5.

Desde PHP 4.0.5,extract_rulesel valor EXTR_PREFIX_ALL también incluye variables numéricas.

Más ejemplos

Ejemplo 1

Utilizar todos los parámetros:

<?php
$a = "Original";
$my_array = array("a" => "Cat", "b" => "Dog", "c" => "Horse");

extract($my_array, EXTR_PREFIX_SAME, "dup");

echo "$a = $a; $b = $b; $c = $c; $dup_a = $dup_a";
?>

Ejecutar ejemplo »

PHP Array ReferenceManual de referencia completo de PHP Array Otras extensiones