NetBeans IDE での PHP ソースコードのデバッグ

目次

• はじめに
• NetBeans IDE での XDebug による PHP デバッグの動作方法
• デバッグオプション
• ツールバーとエディタの操作
• 「デバッガ」ウィンドウ
• デバッグセッション
• デバッグセッションの例
• 追加ウォッチポイントの使用
• PHP と HTML の混在
• パスマッピング、デバッガプロキシ、およびカスタム URL でのデバッグセッションの開始

このチュートリアルに従うには、次のソフトウェアとリソースが必要です。

ソフトウェアまたはリソース	必須バージョン
NetBeans IDE	PHP ダウンロードバンドル
PHP エンジン	version 5
Web サーバー	Apache HTTP Server 2.2 (推奨)
PHP デバッガ	XDebug 2.0 以降

はじめに

NetBeans IDE for PHP で PHP アプリケーションを正常にデバッグするには、PHP エンジン、Apache ローカル Web サーバー、および XDebug デバッガがインストールされ、PHP 開発用に構成されている必要があります。XDebug の動作に問題がある場合、「XDebug に関する NetBeans の Wiki」を参照したり、 のコミュニティーに問い合わせたりしてください。

NetBeans IDE での XDebug による PHP デバッグの動作方法

NetBeans IDE から XDebug を実行すると、PHP プログラムの実行は、ブレークポイントを設定した各行で一時停止します。プログラムの実行が一時停止しているときは、プログラム変数の値など、プログラムの現在の状態に関する情報を XDebug で取得できます。実際にはこれは次のワークフローを意味します。

1. PHP ソースコードの実行を一時停止すべき各行にブレークポイントを設定します。
2. デバッグセッションを開始します。
3. ブレークポイントが設定された行に到達したら、F7 キーおよび F8 キーを押して、スクリプトを 1 行ずつ実行します。デバッガウィンドウでアプリケーションの状態を監視します。
4. デバッグセッションを閉じます。

NetBeans IDE での XDebug の使用方法の詳細なワークフローについては、「デバッグセッション」を参照してください。

NetBeans IDE には、ファイルのステップ実行に役立つデバッグツールバーがあります。「ツールバーとエディタの操作」を参照してください。

デバッグオプション

NetBeans IDE の「オプション」には、PHP をデバッグするための特定のデフォルト設定を変更するタブが含まれています。これらのオプションを開くには、「ツール」>「オプション」(Mac の場合は「NetBeans」>「設定」) に移動し、「PHP」オプションを選択して、「デバッグ」タブを選択します。

注: 「デバッグ」タブは NetBeans IDE version 7.1 で導入されました。以前のバージョンの NetBeans ではデバッグオプションは「一般」>「PHP」タブにあります。version 7.1 のすべてのオプションが以前のバージョンで利用できるとは限りません。

このパネルで次のオプションを変更できます。

• デバッガポート これは、php.ini で設定された、XDebug が使用するポートです。デフォルトでは、これはポート 9000 です。このダイアログのポート番号は、php.ini に設定したデバッガポートと同じである必要があります。このダイアログで、XDebug が使用するポートに影響を与えることはできません。XDebug が使用するポートを NetBeans IDE に通知するだけです。
• セッション ID デバッグセッションの任意の名前。デフォルトでは、これは netbeans-xdebug です。この値は、一部のリモートでのデバッグシナリオなどで、php.ini の xdebug.idekey プロパティーを設定する必要がある場合に注意することが重要です。
• 最初の行で停止 このオプションをオンにすると、デバッガセッションは最初のブレークポイントではなくコードの最初の行で停止します。これにより、デバッグセッションを起動したとき、ブラウザウィンドウに切り替わる代わりに画面が IDE にフォーカスしたままになります。
• ウォッチとバルーン評価 ウォッチポイントとバルーン評価はデフォルトで無効になっています。ウォッチポイントとバルーン評価は XDebug を不安定化させます。
• 構造の最大深さ。 入れ子構造 (入れ子の配列、オブジェクト内部のオブジェクトなど) の可視性を設定します
• 子の最大数。 ウォッチポイント評価中における配列項目の可視性を設定します。(「子の最大数」を 1 に設定した場合、配列が複数の項目を持つ場合でも配列の 1 番目の項目のみが表示されます。)
• 要求された URL を表示。 デバッグ中に新しい「出力」ウィンドウを開きます。この「出力」ウィンドウは「PHP で要求された URL」という名前で、現在処理されている URL を示します。URL はクリック可能です。「出力」ウィンドウの URL をクリックすると、URL がブラウザウィンドウで開きます。
• PHP デバッガコンソール。 デバッグされたスクリプトの出力を表示する新しい「出力」ウィンドウを開きます。

  注: php.ini ファイルで output_buffering = Off と設定してください。それ以外の場合、「出力」ウィンドウにスクリプト出力が表示される際に遅延が生じます。

このチュートリアルでは、ウォッチポイントを任意で有効にすることを除いて、これらの設定を変更する必要はありません。

ツールバーとエディタの操作

エディタではファイルの内容を表示できます。したがって、デバッグ中にエディタとデバッガツールバーを組み合わせて使用することで、実行中にコードをステップ実行して、ファイルの内容がブラウザ内の動作にどのように影響しているのかを確認できます。

• デバッガツールバーの使用
• ブレークポイントの設定
• ツールチップの確認

「デバッガ」ウィンドウ

デバッグセッションを開始すると、一連のデバッガウィンドウがメインエディタウィンドウの下に開きます。デバッガウィンドウでは、コードをステップ実行しながら変数と式の値を追跡したり、実行中のスレッドの呼び出しスタックを確認したり、ソース URL を確認したり、また複数のデバッグセッションを同時に実行している場合はセッション間を切り替えたりできます。

• 「セッション」ウィンドウ
• 「変数」ウィンドウ
• 「ウォッチポイント」ウィンドウ
• 「呼び出しスタック」ウィンドウ
• 「スレッド」ウィンドウ
• 「ソース」ウィンドウ
• 「ブレークポイント」ウィンドウ

すべてのデバッガウィンドウは IDE の「ウィンドウ」>「デバッグ」メニューからアクセスできます。デバッグセッションがアクティブになったら、デバッガウィンドウの使用を開始できます。

デバッグセッション

一般的なデバッグセッションのワークフローを次に示します。

デバッグセッションを実行する

1. IDE を起動し、デバッグするソースコードが含まれるファイルを開きます。
2. デバッガを一時停止する必要がある各行にブレークポイントを設定します。ブレークポイントを設定するには、行の先頭にカーソルを置き、Ctrl-F8/⌘-F8 キーを押すか、「デバッグ」>「行ブレークポイントを切り替え」を選択します。
3. 「プロジェクト」ウィンドウで現在のプロジェクトノードに移動し、マウスの右ボタンをクリックしてポップアップメニューから「デバッグ」を選択します。「デバッガ」ウィンドウが開き、ブレークポイントに達するまで、デバッガでプロジェクトが実行されます。
   注: 現在のプロジェクトが主プロジェクトに設定されている場合は、「デバッグ」>「主プロジェクトをデバッグ」を選択するか、Ctrl-F5 キーを押すか、または をクリックできます。
4. 「局所変数」ウィンドウに切り替えます。このウィンドウには、現在の関数内で初期化されたすべての変数、その型、および値が表示されます。
5. 関数外の変数の値を表示するには、その変数の出現箇所にカーソルを置きます。ツールチップに変数の値が表示されます。
6. 呼び出しているすべての関数内の行を含めてプログラムを 1 行ずつ実行するには、F7 キーを押すか、「デバッグ」>「ステップイン」を選択し、「局所変数」ウィンドウで変数の値の変化を確認します。
7. 式の変化を確認してプログラムのロジックを確認するには、次の手順で新しいウォッチポイントを定義します。
   1. 「ウォッチポイント」ウィンドウを開くには、「ウィンドウ」>「デバッグ」>「ウォッチポイント」を選択するか、Ctrl-Shift-2 キーを押します。「ウォッチポイント」ウィンドウが開きます。
   2. 「ウォッチポイント」ウィンドウ内の任意の場所でマウスの右ボタンをクリックし、ポップアップメニューから「新規ウォッチポイント」を選択します。「新規ウォッチポイント」ウィンドウが開きます。
   3. ウォッチ式を入力し、「了解」をクリックします。

   これでデバッグ中に追加の確認を行うことができます。

   重要: ウォッチポイントを設定するには、PHP オプションの「デバッグ」タブでウォッチポイントを有効にする必要があります。

8. 関数内のコードを 1 行ずつ実行しないで関数呼び出しの次の行まで移動するには、Ctrl-F7/⌘-F7 キーを押すか、「デバッグ」>「ステップアウト」を選択します。
9. 関数内のコードを 1 行ずつ実行しないで、関数から返される値を取得し、関数呼び出しの次の行まで移動するには、F8 キーを押すか、「デバッグ」>「ステップオーバー」を選択します。
10. デバッグセッションを一時停止するには、「デバッグ」>「一時停止」を選択します。
11. デバッグセッションを続行するには、「デバッグ」>「続行」を選択するか、 をクリックします。
12. デバッグセッションを取り消すには、 をクリックします。

13. プログラムの最後に到達すると、デバッガウィンドウが閉じます。

デバッグセッションの例

この節の例では、ステップインやステップオーバー機能などの基本的なデバッガ機能を示します。また、典型的なデバッガウィンドウの出力も示します。

1. 次のパラメータで新しい PHP プロジェクトを作成します。
   • プロジェクトの種類 - PHP アプリケーション
   • ソースの場所 - デフォルトの htdocs フォルダ
   • 実行構成 - ローカル Web サイト
   PHP プロジェクトの設定については、ドキュメント「PHP プロジェクトの設定」を参照してください。
2. セッション中のホットキーの使用を有効にするには、カーソルをプロジェクトノードに置き、ポップアップメニューから「主プロジェクトとして設定」を選択します。
3. index.php ファイルに次のコードを入力します。

     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
     <html>
     	<head>
     		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
     			<title>NetBeans PHP debugging sample</title>
   		</head>
   <body>
   	<?php
     	$m=5;
     	$n=10;
     	  $sum_of_factorials = calculate_sum_of_factorials ($m, $n);
     	  echo "The sum of factorials of the entered integers is " . $sum_of_factorials;
     	
   	    function calculate_sum_of_factorials ($argument1, $argument2) {
     	 	$factorial1 = calculate_factorial ($argument1);
     	 	$factorial2 = calculate_factorial ($argument2);
     	 	$result = calculate_sum ($factorial1, $factorial2);
     	 	return $result;
     		}
   	
   	  function calculate_factorial ($argument) {
     	  	$factorial_result = 1;
     	 	for ($i=1; $i<=$argument; $i++) {
     	 		$factorial_result = $factorial_result*$i;
     	 	}
     			return $factorial_result;
     		}
   	  
   	    function calculate_sum ($argument1, $argument2) {
    			return $argument1 + $argument2;
        	}	
   ?>
     </body>
   </html>
     

   このコードには次の 3 つの関数があります。
   • calculate_factorial () 関数
   • calcualte_sum () 関数
   • calculate_sum_of_factorials () 関数。この関数は calculate_factorial 関数を 2 回呼び出してから calcualte_sum () 関数を 1 回呼び出し、階乗の和を返します。
4. PHP ブロックの先頭にブレークポイントを設定します (Ctrl-F8/⌘-F8)。

   <?php

5. デバッグを開始するには、 をクリックします。デバッガがブレークポイントで停止します。
6. F7 キーを 3 回押します。関数 calculate_sum_of_factorials () を呼び出している行でデバッガが停止します。「局所変数」ウィンドウに、変数 $m と $n、およびそれらの値が表示されます。
   
7. 関数 calculate_sum_of_factorials() にステップインするには、F7 キーを押します。デバッガが関数 calculate_sum_of_factorials () 内のコードの実行を開始し、関数 calculate_factorial() の呼び出しで停止します。
   
   「局所変数」ウィンドウに、関数 calculate_sum_of_factorials () 内で宣言されている局所変数 $argument1 と $argument2 が表示されます。
   
8. F7 キーを押します。デバッガが、関数 calculate_factorial() からコードの実行を開始します。「呼び出しスタック」ウィンドウに、関数への呼び出しのスタックが逆の順序で表示されます。最後に呼び出された関数がリストの先頭に表示されます。
   
9. F7 キーを押してループにステップインします。「変数」ウィンドウで変数の値を確認します。
   
10. コードが正常に機能することを確認したら、Ctrl-F7/⌘-F7 キーを押して関数の実行を取り消します。プログラムは、関数 calculate_factorial() の呼び出しの次の行に戻ります。
    注: プログラムで関数 calculate_factorial() の実行が完了するまで F7 キーを押すこともできます。この場合も、呼び出しの次の行に戻ります。
    
11. 関数 calculate_factorial() が正常に機能することを確認できたので、その実行を省略できます (ステップオーバー)。ステップオーバーするには、F8 キーを押します。プログラムは、関数 calculate_sum() の呼び出しで停止します。
    
12. 関数 calculate_sum() にステップインするには、F7 キーを押します。
13. ステップオーバーするには、F8 キーを押します。いずれの場合もデバッガは関数 calculate_sum_of_factorials() の最後の行で停止します。
    
14. F7 キーを押します。デバッガは echo 文の行に移動します。
15. デバッガがプログラムを終了するまで F7 キーを押します。ブラウザウィンドウが開き、プログラムの実行結果が表示されます。
    

PHP と HTML の混在

PHP と HTML の両方のブロックを含むコードをデバッグできます。「デバッグセッションの例」の節の例では、値はハードコードされています。値を入力するための HTML 入力フォームをコードに追加します。

1. <?php ?> ブロックの上に次の HTML コードを追加します。

    <form action="index.php" method="POST">
          Enter the first integer, please:
          <input type="text" name="first_integer"/><br/>
          Enter the second integer, please:
          <input type="text" name="second_integer"/><br/>
          <input type="submit" name="enter" value="Enter"/>
   </form>

   HTML 入力フォームについては、HTML 入力フォームを参照してください。

2. <?php ?> ブロックの先頭で、次の行を置き換えます。

   $m=5;
     	$n=10;
     	  $sum_of_factorials = calculate_sum_of_factorials ($m, $n);
     	  echo "The sum of factorials of the entered integers is " . $sum_of_factorials;
   

   次のコードに置き換えます。

   if (array_key_exists ("first_integer", $_POST) && array_key_exists ("second_integer", $_POST)) {
   
       $result = calculate_sum_of_factorials ($_POST["first_integer"], $_POST["second_integer"]);
   
       echo "Sum of factorials is " . $result;
   
   }

3. ブレークポイントを <?php ?> ブロックの先頭に設定し、デバッグセッションを開始します。
4. F7 キーを押します。デバッガがプログラムにステップインします。ブラウザウィンドウが開きますが、入力フォームは表示されません。これはデバッガの正常な動作です。Web ページが表示されるためには、デバッガがページのソースコード全体を通過する必要があります。これは実際にはデバッガがコードを 2 回通過することを意味します。1 回目は、HTML 入力フォームを表示するコードが処理されます。2 回目は、PHP コードがステップ実行されます。
5. デバッガがプログラムの終わりに達し、入力フォームが開くまで F7 キーを押します。
6. フォームに入力して Enter キーを押します。デバッグセッションは「デバッグセッションの例」に示すように処理を続行します。

パスマッピング、デバッガプロキシ、およびカスタム URL でのデバッグセッションの開始

スクリプトと Web ページの両方をデバッグすることは可能で、Web ページはローカルまたはリモートのいずれかでデバッグできます。リモートのデバッグの場合、残念なことに、リモートサーバー上のデバッグされる php ファイルは、ローカルマシン上で実行中の NetBeans IDE で開いているファイルと同じではありません。したがって、NetBeans のデバッガサポートは、サーバーパスとローカルパスをマップできる必要があります。ただし、多くの問題があるため、パスマッピングは個々のすべてのシナリオについて自動的に解決できるわけではありません。したがって、NetBeans 6.7 以降では、個々の実行構成について、プロジェクトの設定を使用してパスマッピングを手動で定義できます。また、プロキシサーバーが存在する場合はこれを指定したり、デバッグセッションが開始する URL を指定したりすることもできます。この URL を指定しない場合、デバッグはインデックスファイルから開始します。

パスマッピングを設定してカスタムのデバッグ URL を有効にする

1. 「プロジェクト」ウィンドウでプロジェクトのノードを右クリックし、コンテキストメニューからプロジェクトの「プロパティー」を開きます。
2. 「プロジェクトプロパティー」ダイアログで「実行構成」カテゴリに移動します。
3. 「詳細」ボタンをクリックします。「詳細 Web 構成」ダイアログが開きます。
4. パスマッピング用のサーバーパスとプロジェクトパスを追加します。
5. 「デバッグ URL」で、次のいずれかを選択します (デフォルトを選択したままにしないようにします)。
   
   
   • 「毎回聞く」: デバッグセッションを開始したとき、IDE によって URL の入力が求められます。
   • 「Web ブラウザを開かない」: ブラウザを開いて URL を手動で入力することをユーザーに求めます (GET/POST XDEBUG_SESSION_START 変数が必要です)。
6. デバッグ用のプロキシサーバーを使用する場合、「デバッガプロキシ」セクションにサーバーのホスト名とポートを入力します。

詳細については、NetBeans for PHP ブログの投稿「Path Mapping in PHP Debugger」を参照してください。

メーリングリストに登録することによって、NetBeans IDE PHP 開発機能に関するご意見やご提案を送信したり、サポートを受けたり、最新の開発情報を入手したりできます。

PHP の学習に戻る