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
= "Сан-Франциско";
$state = "CA";
$event = "SIGGRAPH";

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

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

?>

Поданий вище приклад виведе:

Array
(
    [event] => SIGGRAPH
    [city] => Сан-Франциско
    [state] => CA
)

Примітки

Зауваження: Gotcha

Оскільки змінні змінних не можуть бути використані разом з суперглобальним масивом language.variables.superglobals.php в межах функцій, суперглобальні масиви не можуть бути передані в compact().

Прогляньте також

  • extract() - Import variables into the current symbol table from an array

add a note

User Contributed Notes 5 notes

up
171
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
62
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
56
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
1
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
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