mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 07:02:08 +01:00
293 lines
8.5 KiB
XML
293 lines
8.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: a124543dd3f6b1e5567b07420d23899e582514dc Maintainer: hirokawa Status: ready -->
|
|
<!-- CREDITS: takagi,mumumu -->
|
|
<refentry xml:id="function.debug-backtrace" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>debug_backtrace</refname>
|
|
<refpurpose>バックトレースを生成する</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>debug_backtrace</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer><constant>DEBUG_BACKTRACE_PROVIDE_OBJECT</constant></initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>debug_backtrace</function> は PHP バックトレースを生成します。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters"><!-- {{{ -->
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
このパラメータは次のオプションのビットマスクとなります。
|
|
<table>
|
|
<title><function>debug_backtrace</function> のオプション</title>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry>DEBUG_BACKTRACE_PROVIDE_OBJECT</entry>
|
|
<entry>
|
|
"object" インデックスを埋めるかどうか。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>DEBUG_BACKTRACE_IGNORE_ARGS</entry>
|
|
<entry>
|
|
"args" インデックス、
|
|
すなわちすべての関数/メソッドの引数を省略してメモリを節約するかどうか。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
<note>
|
|
<para>
|
|
可能な組み合わせは以下の4つです:
|
|
<table>
|
|
<title><function>debug_backtrace</function> のオプション</title>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry><code>debug_backtrace()</code></entry>
|
|
<entry morerows="2" valign="middle">
|
|
インデックスを両方収集します。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><code>debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT)</code></entry>
|
|
</row>
|
|
<row>
|
|
<entry><code>debug_backtrace(1)</code></entry>
|
|
</row>
|
|
<row>
|
|
<entry><code>debug_backtrace(0)</code></entry>
|
|
<entry valign="middle">
|
|
インデックス <literal>"object"</literal> を省略し、<literal>"args"</literal> を収集します。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><code>debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)</code></entry>
|
|
<entry morerows="1" valign="middle">
|
|
インデックス <literal>"object"</literal> と <literal>"args"</literal> を <emphasis>両方</emphasis>省略します。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><code>debug_backtrace(2)</code></entry>
|
|
</row>
|
|
<row>
|
|
<entry><code>debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT|DEBUG_BACKTRACE_IGNORE_ARGS)</code></entry>
|
|
<entry morerows="1" valign="middle">
|
|
インデックス <literal>"object"</literal> を収集し、<literal>"args"</literal> を省略します。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><code>debug_backtrace(3)</code></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</note>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>limit</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
このパラメータを使ってスタックフレームの数を制限できます。
|
|
デフォルト (<parameter>limit</parameter>=<literal>0</literal>) は、すべてのスタックフレームを返します。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
連想配列の配列を返します。連想配列の要素として返される可能性があるものは以下のとおりです。
|
|
</para>
|
|
<para>
|
|
<table>
|
|
<title>
|
|
<function>debug_backtrace</function> から返される可能性がある要素
|
|
</title>
|
|
<tgroup cols="3">
|
|
<thead>
|
|
<row>
|
|
<entry>&Name;</entry>
|
|
<entry>&Type;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>function</entry>
|
|
<entry><type>string</type></entry>
|
|
<entry>
|
|
カレントの関数名。
|
|
<link
|
|
linkend="language.constants.magic">__FUNCTION__</link>
|
|
も参照ください。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>line</entry>
|
|
<entry><type>int</type></entry>
|
|
<entry>
|
|
カレントの行番号。
|
|
<link linkend="language.constants.magic">__LINE__</link>
|
|
も参照ください。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>file</entry>
|
|
<entry><type>string</type></entry>
|
|
<entry>
|
|
カレントのファイル名。
|
|
<link linkend="language.constants.magic">__FILE__</link>
|
|
も参照ください。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>class</entry>
|
|
<entry><type>string</type></entry>
|
|
<entry>
|
|
カレントの<link linkend="language.oop5">クラス</link>名。
|
|
<link linkend="language.constants.magic">__CLASS__</link>
|
|
も参照ください。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>object</entry>
|
|
<entry><type>object</type></entry>
|
|
<entry>
|
|
カレントの<link linkend="language.oop5">オブジェクト</link>。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>type</entry>
|
|
<entry><type>string</type></entry>
|
|
<entry>
|
|
カレントのコール方式。メソッドを呼び出している場合は "->"、
|
|
staticメソッドを呼び出している場合は "::" が返されます。
|
|
関数呼び出しの場合は何も返されません。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>args</entry>
|
|
<entry><type>array</type></entry>
|
|
<entry>
|
|
関数の内部の場合、関数の引数のリストとなります。
|
|
インクルードされたファイル内では、
|
|
読み込まれたファイルの名前となります。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>debug_backtrace</function> の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// ファイル名: /tmp/a.php
|
|
|
|
function a_test($str)
|
|
{
|
|
echo "\nHi: $str";
|
|
var_dump(debug_backtrace());
|
|
}
|
|
|
|
a_test('friend');
|
|
?>
|
|
|
|
<?php
|
|
// ファイル名: /tmp/b.php
|
|
include_once '/tmp/a.php';
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
<filename>/tmp/b.php</filename>
|
|
を実行した際の結果は以下のようになります。
|
|
</para>
|
|
<screen>
|
|
<![CDATA[
|
|
Hi: friend
|
|
array(2) {
|
|
[0]=>
|
|
array(4) {
|
|
["file"] => string(10) "/tmp/a.php"
|
|
["line"] => int(10)
|
|
["function"] => string(6) "a_test"
|
|
["args"]=>
|
|
array(1) {
|
|
[0] => &string(6) "friend"
|
|
}
|
|
}
|
|
[1]=>
|
|
array(4) {
|
|
["file"] => string(10) "/tmp/b.php"
|
|
["line"] => int(2)
|
|
["args"] =>
|
|
array(1) {
|
|
[0] => string(10) "/tmp/a.php"
|
|
}
|
|
["function"] => string(12) "include_once"
|
|
}
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>trigger_error</function></member>
|
|
<member><function>debug_print_backtrace</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
|
|
-->
|