compact

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

compactСоздаёт массив, содержащий названия переменных и их значения

Описание

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

Создаёт массив, содержащий переменные и их значения.

Для каждого из переданного параметров, функция compact() ищет переменную с указанным именем в текущей таблице символов и добавляет их в выводимый массив так, что имя переменной становится ключом, а содержимое переменной становится значением этого ключа. Короче говоря, она противоположна функции extract().

Замечание:

До PHP 7.3 любые неустановленные строки будут просто пропущены.

Список параметров

var_name
var_names

compact() принимает неограниченное количество параметров. Любой из параметров может быть либо строкой, содержащей название переменной, либо массивом названий переменных. Массив может содержать вложенные массивы названий переменных; функция compact() обрабатывает их рекурсивно.

Возвращаемые значения

Возвращает массив со всеми переменными, добавленными в него.

Ошибки

compact() выдаёт ошибку уровня E_NOTICE, если данная строка относится к удалённой переменной.

Список изменений

Версия Описание
7.3.0 compact() теперь выдаёт ошибку уровня E_NOTICE, если заданная строка связана с удалённой переменной. Ранее такие строки пропускались без всякого уведомления.

Примеры

Пример #1 Пример использования compact()

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

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

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

Результат выполнения данного примера:

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

Примечания

Замечание: Замечания по работе функции compact

Так как переменные переменных не могут быть использованы с суперглобальными массивами внутри функций, суперглобальные массивы не могут быть переданы в compact().

Смотрите также

  • extract() - Импортирует переменные из массива в текущую таблицу символов

add a note add a note

User Contributed Notes 4 notes

up
152
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
7
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
35
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
30
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.
To Top