mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
fix whitespaces
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@187897 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jean-Sébastien Goupil
parent
906e722f00
commit
9a339e6b78
1 changed files with 94 additions and 88 deletions
|
|
@ -1,71 +1,75 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<!-- $Revision: 1.10 $ -->
|
||||
<!-- 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">
|
||||
<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>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
array (
|
||||
0 => 1,
|
||||
|
|
@ -78,8 +82,8 @@ array (
|
|||
),
|
||||
)
|
||||
]]>
|
||||
</screen>
|
||||
<programlisting role="php">
|
||||
</screen>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
|
|
@ -89,35 +93,37 @@ echo $v;
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
3.1
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<note>
|
||||
<para>
|
||||
Variables of type <type>resource</type> and arrays or objects containing
|
||||
objects couldn't be exported by this function.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>var_dump</function></member>
|
||||
<member><function>print_r</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<note>
|
||||
<para>
|
||||
Variables of type <type>resource</type> and arrays or objects containing
|
||||
objects couldn't be exported by this function.
|
||||
</para>
|
||||
</note>
|
||||
</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:
|
||||
|
|
|
|||
Loading…
Reference in a new issue