<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: d58ee8eaaa7f716c51f66f5f1058ab3c42376d98 Maintainer: cmb Status: ready -->

<!-- Reviewed: yes -->

<!-- Rev-Revision: cd943f94a013b74df8765ab8e1a620a916a64a85 Reviewer: samesch -->

<!-- CREDITS: tom -->

<refentry xml:id="function.compact" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>compact</refname>

<refpurpose>Erstellt ein Array mit Variablen und deren Werten</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>array</type><methodname>compact</methodname>

<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>var_name</parameter></methodparam>

<methodparam rep="repeat"><type class="union"><type>array</type><type>string</type></type><parameter>var_names</parameter></methodparam>

</methodsynopsis>

<para>

Erstellt ein Array mit Variablen und deren Werten.

</para>

<para>

Für jede dieser Variablen sucht <function>compact</function> nach einer

Variablen in der aktuellen

<link linkend="features.gc.refcounting-basics">Symboltabelle</link> 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 <function>extract</function>.

</para>

<note>

<para>

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

ignoriert.

</para>

</note>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>var_name</parameter></term>

<term><parameter>var_names</parameter></term>

<listitem>

<para>

<function>compact</function> ü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;

<function>compact</function> behandelt sie rekursiv.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Gibt ein Array mit allen Variablen zurück.

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

<function>compact</function> erzeugt eine Fehlermeldung der Stufe

<constant>E_WARNING</constant>, wenn sich ein gegebener String auf eine

nicht gesetzte Variable bezieht.

</para>

</refsect1>

<refsect1 role="changelog"><!-- {{{ -->

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.0</entry>

<entry>

Wenn ein gebener String auf eine nicht gesetzte Variable verweist,

wird nun ein Fehler der Stufe <constant>E_WARNING</constant> erzeugt.

</entry>

</row>

<row>

<entry>7.3.0</entry>

<entry>

<function>compact</function> erzeugt nun eine Fehlermeldung der Stufe

<constant>E_NOTICE</constant>, wenn sich ein gegebener String auf eine

nicht gesetzte Variable bezieht. Zuvor wurden solche Strings

stillschweigend ausgelassen.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1><!-- }}} -->

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>compact</function>-Beispiel</title>

<programlisting role="php">

<![CDATA[

<?php

$city = "San Francisco";

$state = "CA";

$event = "SIGGRAPH";

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

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

print_r($result);

?>

]]>

</programlisting>

&example.outputs;

<screen role="php">

<![CDATA[

Array

(

[event] => SIGGRAPH

[city] => San Francisco

[state] => CA

)

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<title>Achtung</title>

<para>

Weil <link linkend="language.variables.variable">variable Variablen</link>

in Funktionen nicht mit PHPs

<link linkend="language.variables.superglobals">superglobalen Arrays</link>

verwendet werden dürfen, können die superglobalen Arrays nicht an

<function>compact</function> übergeben werden.

</para>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>extract</function></member>

</simplelist>

</para>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->