<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.var.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.debug-zval-dump.php',
    1 => 'debug_zval_dump',
    2 => '内部的な zval を表す文字列をダンプする',
  ),
  'up' => 
  array (
    0 => 'ref.var.php',
    1 => '変数操作 関数',
  ),
  'prev' => 
  array (
    0 => 'function.boolval.php',
    1 => 'boolval',
  ),
  'next' => 
  array (
    0 => 'function.doubleval.php',
    1 => 'doubleval',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/var/functions/debug-zval-dump.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.debug-zval-dump" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">debug_zval_dump</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">debug_zval_dump</span> &mdash; <span class="dc-title">内部的な zval を表す文字列をダンプする</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.debug-zval-dump-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>debug_zval_dump</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">...$values</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="para rdfs-comment">
   内部的な zval (Zend の値) を表す文字列表現をダンプします。
   これは Zend Engine や PHP 拡張モジュールの実装の詳細をデバッグしたり、理解したりするのに役立ちます。
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.debug-zval-dump-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">value</code></dt>
     <dd>
      <p class="para">
       ダンプする変数または値。
      </p>
     </dd>
    
    
     <dt><code class="parameter">values</code></dt>
     <dd>
      <p class="para">
       ダンプする追加の変数または値。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.debug-zval-dump-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   値を返しません。
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.debug-zval-dump-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>debug_zval_dump()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$var1 </span><span style="color: #007700">= </span><span style="color: #DD0000">'Hello'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$var1 </span><span style="color: #007700">.= </span><span style="color: #DD0000">' World'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$var2 </span><span style="color: #007700">= </span><span style="color: #0000BB">$var1</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">debug_zval_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$var1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>上の例の出力は以下となります。</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">string(11) &quot;Hello World&quot; refcount(3)</pre>
</div>
    </div>
   </div>
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <strong><code class="literal">refcount</code> を理解する</strong><br />
   <p class="para">
    Zend Engine の実装の詳細を理解していないと、
    この関数が表示する <code class="literal">refcount</code> の値に驚くかもしれません。
   </p>
   <p class="para">
    Zend Engine は、リファレンスカウントを以下の2つの用途で使います:
   </p>
   <p class="para">
    <ul class="simplelist">
     <li>
      "コピーオンライト" と呼ばれるテクニックを使ってメモリを最適化し、
      値が同じ複数の値を保持する複数の変数を、メモリ上の同じコピーを指すようにします。
      この場合、変数の値が変更された時に、
      その変数は新しいメモリ上のコピーの値を指すようになります。
      そして、その変数のリファレンスカウントは1になります。
     </li>
     <li>
      リファレンス渡しされたり、リファレンスが代入されている値(
      <a href="language.references.php" class="link">リファレンスの説明</a> も参照ください)
      を追跡する用途にも使います。
      この用途のリファレンスカウントは、
      現在の値を指しているものとは別の、リファレンス用の zval に保存されています。
      この追加の zval は、現状
      <span class="function"><strong>debug_zval_dump()</strong></span> では見えません。
     </li>
    </ul>
   </p>
   <p class="para">
    <span class="function"><strong>debug_zval_dump()</strong></span> は、値渡しされた通常の引数を入力として受け取るので、
    コピーオンライトのテクニックを使います: つまり、データをコピーせず、
    関数呼び出しが行われている間、リファレンスカウントをひとつ増やします。
    関数が受け取った引数を変更すると、データのコピーが行われます。
    コピーを行わないと、呼び出しスコープの中でリファレンスカウントがひとつ増えてしまうからです。
   </p>
   <p class="para">
    渡す引数によっては、<span class="function"><strong>debug_zval_dump()</strong></span>
    はリファレンスが割り当てられている変数を表示しません。
    この動きを示すために、上の例をちょっと変更した例を考えてみましょう:
   <div class="informalexample">
     <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$var1 </span><span style="color: #007700">= </span><span style="color: #DD0000">'Hello'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$var1 </span><span style="color: #007700">.= </span><span style="color: #DD0000">' World'</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// Point three variables as references to the same value<br /></span><span style="color: #0000BB">$var2 </span><span style="color: #007700">=&amp; </span><span style="color: #0000BB">$var1</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$var3 </span><span style="color: #007700">=&amp; </span><span style="color: #0000BB">$var1</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">debug_zval_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$var1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

     <p class="para">上の例の出力は以下となります。</p>
     <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">string(11) &quot;Hello World&quot; refcount(2)</pre>
</div>
     </div>
    </div>
   </p>
   <p class="para">
    <var class="varname">$var1</var>, <var class="varname">$var2</var>,
    <var class="varname">$var3</var> はリファレンスで結びついていますが、
    <em>値</em> だけが <span class="function"><strong>debug_zval_dump()</strong></span> に渡されます。
    この値は、リファレンスの設定に一度使われ、
    <span class="function"><strong>debug_zval_dump()</strong></span> の中で一度使われます。
    よって、リファレンスカウントは2になります。
   </p>
   <p class="para">
    データ型によっては、Zend Engine 内で最適化が行われてしまうため、
    ユーザはさらに混乱してしまいます。
    整数のように &quot;コピーオンライト&quot; を行わないデータ型の変数では、
    リファレンスカウントを全く表示しません。
    別の場合、このリファレンスカウントの値は、
    内部的に使われる追加のコピーの値を表示する場合もあります。
    たとえば、文字列リテラルや配列が、命令セットの一部として保存されているような場合です。
   </p>
  </p></blockquote>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.debug-zval-dump-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.var-dump.php" class="function" rel="rdfs-seeAlso">var_dump()</a> - 変数に関する情報をダンプする</span></li>
    <li><span class="function"><a href="function.debug-backtrace.php" class="function" rel="rdfs-seeAlso">debug_backtrace()</a> - バックトレースを生成する</span></li>
    <li><a href="language.references.php" class="link">リファレンスの説明</a></li>
    <li><a href="http://derickrethans.nl/php_references_article.php" class="link external">&raquo;&nbsp;References Explained (by Derick Rethans)</a></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>