print-r.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 649598d5e2965b2565f7724cdb4fd4f094d4c81e Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xml:id="function.print-r" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>print_r</refname>
  <refpurpose>
   指定した変数に関する情報を解りやすく出力する
  </refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>true</type></type><methodname>print_r</methodname>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>return</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>print_r</function> は、
   変数の値に関する情報を解り易い形式で表示します。
  </para>
  <para>
   <function>print_r</function>、<function>var_dump</function>
   および <function>var_export</function>
   は、オブジェクトの protected および private のプロパティも表示します。
   static が付いたクラスメンバーは表示されません。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       表示したい式。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>return</parameter></term>
     <listitem>
      <para>
       <function>print_r</function> の結果を取得したい場合には
       <parameter>return</parameter> 引数を使います。
       この引数が &true; の場合には、
       <function>print_r</function> は情報を表示するかわりに情報を返します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <type>string</type>、<type>int</type>、
   <type>float</type> を指定した場合はその値が出力されます。
   <type>array</type> を指定した場合、キーと要素を表す形式で値が
   表示されます。<type>object</type> に関しても同様の表示形式となります。
  </para>
  <para>
   <parameter>return</parameter> パラメータが &true; の場合は、
   この関数は <type>string</type> を返します。それ以外の場合の戻り値は &true; です。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.4.0</entry>
       <entry>
        戻り値の型が、<type class="union"><type>string</type><type>bool</type></type> から
        <type class="union"><type>string</type><type>true</type></type> に変更されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>print_r</function> の例</title>
    <programlisting role="php">
<![CDATA[
<pre>
<?php
$a = array ('a' => 'apple', 'b' => 'banana', 'c' => array ('x', 'y', 'z'));
print_r ($a);
?>
</pre>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
<pre>
Array
(
    [a] => apple
    [b] => banana
    [c] => Array
        (
            [0] => x
            [1] => y
            [2] => z
        )
)
</pre>
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><parameter>return</parameter> 引数の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$b = array ('m' => 'monkey', 'foo' => 'bar', 'x' => array ('x', 'y', 'z'));
$results = print_r($b, true); // print_r の結果が $results に格納されます
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.uses-ob-php70;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ob_start</function></member>
    <member><function>var_dump</function></member>
    <member><function>var_export</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
-->