repo_zf1/documentation/manual/ja/module_specs/Zend_Debug.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 17782 -->
<sect1 id="zend.debug.dumping">

    <title>変数の出力</title>

    <para>
        静的メソッド <methodname>Zend_Debug::dump()</methodname> は、
        式の内容を表示したり返したりします。
        この単純なデバッグ手法は、一般的によく用いられています。
        というのも、簡単に使用することができ、事前準備や特別なツール、
        デバッグ用環境などが不要だからです。
    </para>

    <example id="zend.debug.dumping.example">
        <title>dump() メソッドの例</title>
        <programlisting language="php"><![CDATA[
Zend_Debug::dump($var, $label=null, $echo=true);
]]></programlisting>
    </example>

    <para>
        引数 <varname>$var</varname> で指定した式や変数についての情報を
        <methodname>Zend_Debug::dump()</methodname> メソッドが出力します。
    </para>

    <para>
        引数 <varname>$label</varname> は、<methodname>Zend_Debug::dump()</methodname>
        の出力の前に出力される文字列です。
        これは、たとえば複数の変数の内容を出力する際に便利です。
    </para>

    <para>
        論理型の <varname>$echo</varname> で、<methodname>Zend::dump()</methodname> の結果を
        echo するかどうかを指定します。<constant>TRUE</constant> の場合は出力が
        echo されます。<varname>$echo</varname> の設定にかかわらず、
        出力結果は常にメソッドの返り値となります。
    </para>

    <para>
        内部構造を知っておくと、挙動が理解しやすくなります。
        <methodname>Zend_Debug::dump()</methodname> メソッドは、PHP の関数
        <ulink url="http://php.net/var_dump"><methodname>var_dump()</methodname></ulink>
        をラップしたものです。出力ストリームがウェブに渡された場合、
        <methodname>var_dump()</methodname> の出力は
        <ulink url="http://php.net/htmlspecialchars"><methodname>htmlspecialchars()</methodname></ulink>
        でエスケープされ、(X)HTML の <command>&lt;pre&gt;</command> タグで囲まれます。
    </para>

    <tip>
        <title>Zend_Log を使用したデバッグ</title>
        <para>
            <methodname>Zend_Debug::dump()</methodname> は、ソフトウェアの開発中の
            ちょっとしたデバッグには最適です。
            変数の中身を見るメソッドを追加したり削除したりするのが手っ取り早くできます。
        </para>
        <para>
            その場限りのコードではなくずっと使用し続けるデバッグコードを書くのなら、
            <link linkend="zend.log.overview">Zend_Log</link>
            の使用を検討してください。たとえば、ログレベルを
            <constant>DEBUG</constant> にして Stream ログライターを使用すると、
            <methodname>Zend_Debug::dump()</methodname> が返す文字列を出力することができます。
        </para>
    </tip>

</sect1>
<!--
vim:se ts=4 sw=4 et:
-->