mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
0b93bd27f7
<para> <example> <title /> <programlisting> <![CDATA[ <?php echo "foo\n"; ?> ]]> </programlisting> <para> The output is: </para> <screen> <![CDATA[ foo ]]> </screen> </example> </para> git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@131857 c90b9560-bf6c-de11-be94-00142212c4b1
92 lines
2.6 KiB
XML
92 lines
2.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
|
|
<refentry id="function.compact">
|
|
<refnamediv>
|
|
<refname>compact</refname>
|
|
<refpurpose>
|
|
Create array containing variables and their values
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>compact</methodname>
|
|
<methodparam><type>mixed</type><parameter>varname</parameter></methodparam>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>compact</function> takes a variable number of
|
|
parameters. Each parameter can be either a string containing the
|
|
name of the variable, or an array of variable names. The array
|
|
can contain other arrays of variable names inside it;
|
|
<function>compact</function> handles it recursively.
|
|
</para>
|
|
<para>
|
|
For each of these, <function>compact</function> looks for a
|
|
variable with that name in the current symbol table and adds it
|
|
to the output array such that the variable name becomes the key
|
|
and the contents of the variable become the value for that key.
|
|
In short, it does the opposite of <function>extract</function>.
|
|
It returns the output array with all the variables added to it.
|
|
</para>
|
|
<para>
|
|
Any strings that are not set will simply be skipped.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>compact</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$city = "San Francisco";
|
|
$state = "CA";
|
|
$event = "SIGGRAPH";
|
|
|
|
$location_vars = array ("city", "state");
|
|
|
|
$result = compact ("event", "nothing_here", $location_vars);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
After this, <varname>$result</varname> will be:
|
|
</para>
|
|
<screen role="php">
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[event] => SIGGRAPH
|
|
[city] => San Francisco
|
|
[state] => CA
|
|
)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also <function>extract</function>.
|
|
</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:"../../../../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
|
|
-->
|