mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
dfa559fbf4
Switch more files to the new layout git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183766 c90b9560-bf6c-de11-be94-00142212c4b1
132 lines
3.2 KiB
XML
132 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.8 $ -->
|
|
<!-- splitted from ./en/functions/var.xml, last change in rev 1.6 -->
|
|
<refentry id="function.var-export">
|
|
<refnamediv>
|
|
<refname>var_export</refname>
|
|
<refpurpose>Outputs or returns a parsable string representation of a variable</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>var_export</methodname>
|
|
<methodparam><type>mixed</type><parameter>expression</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
<function>var_export</function> gets structured information about the
|
|
given variable. It is similar to <function>var_dump</function>
|
|
with one exception: the returned representation is valid PHP code.
|
|
</simpara>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>expression</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The variable you want to export.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>return</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If used and set to &true;, <function>var_export</function> will return
|
|
the variable representation instead of outputing it.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the variable representation when the <parameter>return</parameter>
|
|
parameter is used and evaluates to &true;. Otherwise, this function will
|
|
return &null;.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>var_export</function> Examples</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$a = array (1, 2, array ("a", "b", "c"));
|
|
var_export($a);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
array (
|
|
0 => 1,
|
|
1 => 2,
|
|
2 =>
|
|
array (
|
|
0 => 'a',
|
|
1 => 'b',
|
|
2 => 'c',
|
|
),
|
|
)
|
|
]]>
|
|
</screen>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$b = 3.1;
|
|
$v = var_export($b, true);
|
|
echo $v;
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
3.1
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>var_dump</function></member>
|
|
<member><function>print_r</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:"../../../../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
|
|
-->
|