var-dump.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/var.xml, last change in rev 1.84 -->
<refentry xml:id="function.var-dump" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>var_dump</refname>
  <refpurpose>Dumps information about a variable</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>var_dump</methodname>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
   <methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   This function displays structured information about one or more
   expressions that includes its type and value. Arrays and objects are
   explored recursively with values indented to show structure.
  </simpara>
  <simpara>
   All public, private and protected properties of objects will be returned in
   the output unless the object implements a
   <link linkend="language.oop5.magic.debuginfo">__debugInfo()</link> method.
  </simpara>
  &tip.ob-capture;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       The expression to dump.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       Further expressions to dump.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>var_dump</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = array(1, 2, array("a", "b", "c"));
var_dump($a);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(3) {
  [0]=>
  int(1)
  [1]=>
  int(2)
  [2]=>
  array(3) {
    [0]=>
    string(1) "a"
    [1]=>
    string(1) "b"
    [2]=>
    string(1) "c"
  }
}
]]>
    </screen>
    <programlisting role="php">
<![CDATA[
<?php

$b = 3.1;
$c = true;
var_dump($b, $c);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
float(3.1)
bool(true)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>print_r</function></member>
    <member><function>debug_zval_dump</function></member>
    <member><function>var_export</function></member>
    <member><link linkend="language.oop5.magic.debuginfo">__debugInfo()</link></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
-->