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 atual e a adiciona no array de saída de forma que o nome da variável se torne a chave e o conteúdo da variável se torne o valor para essa chave. Em resumo, ela faz o oposto de extract().

Note:

Antes do PHP 7.3, quaisquer strings que não estejam definidas seriam 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

Example #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

Note: Armadilha

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