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_WARNING, если строка ссылается на переменную, которую не установили.

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

Версия Описание
8.0.0 Функция теперь генерирует ошибку уровня E_WARNING, если строка ссылается на переменную, которую не установили.
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() - Импортирует переменные массива в текущую таблицу символов

Добавить

Примечания пользователей 5 notes

up
170
M Spreij
17 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
63
lekiagospel at gmail dot com
5 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
56
jmarkmurph at yahoo dot com
9 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
2
c dot smith at fantasticmedia dot co dot uk
1 year 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;
}
}
?>
up
28
Robc
14 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