PHP 8.3.4 Released!

compact

(PHP 4, PHP 5, PHP 7, PHP 8)

compactCria um array contendo variáveis e seus valores

Descrição

compact(array|string $var_name, array|string ...$var_names): array

Cria um array contendo variáveis e seus valores.

Para cada um dos parâmetros passados, compact() procura uma variável com o nome especificado na tabela de símbolos e a adiciona no array de saída de forma que o nome da variável será a chave e o seu conteúdo será o valor para esta chave. Em resumo, ela faz o oposto de extract().

Nota:

Antes do PHP 7.3, quaisquer strings que não estão definidas serão silenciosamente ignoradas.

Parâmetros

var_name
var_names

compact() recebe um número variável de parâmetros. Cada parâmetro pode ser ou uma string contendo o nome da variável, ou um array de nomes de variáveis. O array pode conter outros arrays de nomes de variáveis; compact() o manipula recursivamente.

Valor Retornado

Retorna a saída do array com todas as variáveis adicionadas a ele.

Erros/Exceções

compact() emite um erro nível E_WARNING se uma determinada string se refere a uma variável não definida.

Registro de Alterações

Versão Descrição
8.0.0 Se uma determinada string fizer referência a uma variável não definida, um erro de nível E_WARNING será emitido.
7.3.0 compact() agora emite um erro nível E_NOTICE se uma determinada string se refere a uma variável não definida. Anteriomente, strings como essa seriam ignoradas silenciosamente.

Exemplos

Exemplo #1 Exemplo de compact()

<?php
$cidade
= "Sao Paulo";
$estado = "SP";
$evento = "SIGGRAPH";

$vars_localidade = array("cidade", "estado");

$result = compact("evento", $vars_localidade);
print_r($result);
?>

O exemplo acima produzirá:

Array
(
    [evento] => SIGGRAPH
    [cidade] => Sao Paulo
    [estado] => SP
)

Notas

Nota: Gotcha

Devido a variáveis variável não poderem ser usadas com arrays superglobais do PHP dentro de funções, os arrays superglobais não podem ser passados na compact().

Veja Também

  • extract() - Importa variáveis para a tabela de símbolos a partir de um array

add a note

User Contributed Notes 5 notes

up
169
M Spreij
16 years ago
Can also handy for debugging, to quickly show a bunch of variables and their values:

<?php
print_r
(compact(explode(' ', 'count acw cols coldepth')));
?>

gives

Array
(
[count] => 70
[acw] => 9
[cols] => 7
[coldepth] => 10
)
up
60
lekiagospel at gmail dot com
4 years ago
Consider these two examples. The first as used in the manual, and the second a slight variation of it.

Example #1

<?php
$city
= "San Francisco";
$state = "CA";
$event = "SIGGRAPH";

$location_vars = array("city", "state");

$result = compact("event", $location_vars);
print_r($result);
?>

Example #1 above will output:

Array
(
[event] => SIGGRAPH
[city] => San Francisco
[state] => CA
)

Example #2

<?php
$city
= "San Francisco";
$state = "CA";
$event = "SIGGRAPH";

$location_vars = array("city", "state");

$result = compact("event", "location_vars");
print_r($result);
?>

Example #2 above will output:

Array
(
[event] => SIGGRAPH

[location_vars] => Array
(
[0] => city
[1] => state
)

)

In the first example, the value of the variable $location_values (which is an array containing city, and state) is passed to compact().

In the second example, the name of the variable $location_vars (i.e without the '$' sign) is passed to compact() as a string. I hope this further clarifies the points made in the manual?
up
54
jmarkmurph at yahoo dot com
8 years ago
So compact('var1', 'var2') is the same as saying array('var1' => $var1, 'var2' => $var2) as long as $var1 and $var2 are set.
up
29
Robc
13 years ago
The description says that compact is the opposite of extract() but it is important to understand that it does not completely reverse extract(). In particluar compact() does not unset() the argument variables given to it (and that extract() may have created). If you want the individual variables to be unset after they are combined into an array then you have to do that yourself.
up
2
c dot smith at fantasticmedia dot co dot uk
5 months ago
If you must utilise this knowing that a variable may be unset, then you need to use an alternative method.

So instead of the following:

<?php
$var1
= "lorem";
$var2 = "ipsum";
$result = compact('var1', 'var2', 'unsetvar');
?>

Consider the following:

<?php
$var1
= "lorem";
$var2 = "ipsum";
$result = [];
foreach( [
'var1', 'var2', 'unsetvar'] as $attr ) {
if ( isset( $
$attr ) ) {
$result[ $attr ] = $$attr;
}
}
?>
To Top