PHP 8.4.2 Released!

compact

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

compactErstellt ein Array mit Variablen und deren Werten

Beschreibung

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

Erstellt ein Array mit Variablen und deren Werten.

Für jede dieser Variablen sucht compact() nach einer Variablen in der aktuellen Symboltabelle und fügt diese dem zurückzugebenden Array hinzu, wobei der Variablenname als Schlüssel und der Inhalt der Variablen als Wert gespeichert wird. Kurz gesagt, diese Funktion tut das Gegenteil von extract().

Hinweis:

Vor PHP 7.3 wurden Strings, welche nicht gesetzt sind, stillschweigend ignoriert.

Parameter-Liste

var_name
var_names

compact() übernimmt eine variable Anzahl von Parametern. Jeder Parameter kann entweder ein String mit einem Variablennamen, oder ein Array mit Variablennamen sein. Dieses Array kann auch andere Arrays mit Variablennamen enthalten; compact() behandelt sie rekursiv.

Rückgabewerte

Gibt ein Array mit allen Variablen zurück.

Fehler/Exceptions

compact() erzeugt eine Fehlermeldung der Stufe E_WARNING, wenn sich ein gegebener String auf eine nicht gesetzte Variable bezieht.

Changelog

Version Beschreibung
8.0.0 Wenn ein gebener String auf eine nicht gesetzte Variable verweist, wird nun ein Fehler der Stufe E_WARNING erzeugt.
7.3.0 compact() erzeugt nun eine Fehlermeldung der Stufe E_NOTICE, wenn sich ein gegebener String auf eine nicht gesetzte Variable bezieht. Zuvor wurden solche Strings stillschweigend ausgelassen.

Beispiele

Beispiel #1 compact()-Beispiel

<?php

$city
= "San Francisco";
$state = "CA";
$event = "SIGGRAPH";

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

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

?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

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

Anmerkungen

Hinweis: Achtung

Weil variable Variablen in Funktionen nicht mit PHPs superglobalen Arrays verwendet werden dürfen, können die superglobalen Arrays nicht an compact() übergeben werden.

Siehe auch

  • extract() - Importiert Variablen eines Arrays in die aktuelle Symboltabelle

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