extract

Import variables into the current symbol table from an array.

extract Function synopsis

extract(
    array &$array,
    int $flags = EXTR_OVERWRITE,
    string $prefix = ""
  ): int

Parameters

$array

Passed by referenceTypearray

An associative array. This function treats keys as variable names and values as variable values. For each key/value pair it will create a variable in the current symbol table, subject to $flags and $prefix parameters.

$flags

OptionalTypeintDefault valueEXTR_OVERWRITE

The way invalid/numeric keys and collisions are treated is determined by the extraction $flags. It can be one of the following values:

$prefix

OptionalTypestringDefault value""

Note that $prefix is only required if $flags is EXTR_PREFIX_SAME, EXTR_PREFIX_ALL, EXTR_PREFIX_INVALID or EXTR_PREFIX_IF_EXISTS. If the prefixed result is not a valid variable name, it is not imported into the symbol table. Prefixes are automatically separated from the array key by an underscore character.

Note that the parameter $array is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typeint

Returns the number of variables successfully imported into the symbol table.