誰でも簡単!PHPのデバッグ環境の整え方(ステップ実行可能)【VisualStudioCode】

どうも皆さんこんにちは。システムチームのSDでございます。

皆さん、PHPのデバッグってどうしてますか?
var_dumpやprint_r、はたまたechoを使うというのでも十分な場合はあるでしょう。
しかし、実装が複雑になってくるとやはりステップ実行でデバッグしたくなってくるものです。

そこで今回は「誰でも」「カンタン」に出来るをテーマに、PHPのデバッグ環境構築方法をご紹介していこうと思います。

※エディターとしてVisualStudioCodeを使用します。
※当環境のphpバージョンは 7.2.10です。
デバッガーの機能を使うにはphp7.0以上必須です。

 

Xdebugのインストール

まずはPHPのデバッグツールであるXdebugをインストールします。
下記のサイトにアクセスしてください。

https://xdebug.org/wizard.php

 

ターミナルを起動し、 php -i を実行して出力をすべてコピーしておきます。
(ターミナルの起動はWinキー + R でファイル名を指定して実行⇒「cmd」と入力するなどで実行できます。)

phpinfo加工
そのコピー内容を↓のページの入力欄に貼り付け、「Analyze my phpinfo() outputs」ボタンを押します。

xdebug-go加工
その情報をもとWebページがあなたのシステムに最適なバージョンのXdebugと、
その適用手順を案内してくれます。

result加工

まず1.に推奨バージョンのダウンロードリンクが貼られているのでダウンロードします。

clickToDownload

そして2.にパスが書いてあるので、そのフォルダにダウンロードしたXdebugを移動します。

moveto

最後に3.ですが、php.iniというphpの起動設定が書かれたファイルの編集をする必要がありますので、
次の項目で見ていきましょう。

 

php.iniファイルの編集

上記にもある通り、Xdebugのパス情報をphp.iniに追記する必要があります。
ただし、それだけでは動かないので以下のように追記してください。

phpini加工

追記する場所はわかりやすいようにphp.iniファイルの末尾でいいでしょう。

 

Visual Studio Codeのインストール

デバッグ機能を使うために、今回はVisualStudioCodeを利用します。

https://code.visualstudio.com/

上記のWebページからダウンロードしましょう。

vsc加工

ダウンロードが終わったらVisualStudioCodeを実行しましょう。

 

Visual Studio Codeの日本語化

起動出来ましたか?
しかし言語はデフォルトでは英語なのでこのままだとわかりづらいですね。
そこで拡張機能をインストールして日本語化しましょう。

vscjap加工
画面左メニューから「拡張機能」タブをクリックし、「Japanese」と検索。
「Japanese Language Pack for Visual Studio Code」をインストールしエディタを再起動すれば日本語化されます。

 

PHP IntelliSense、PHP Debugのインストール

上記と同じ手順で拡張機能から検索し、
PHP InteliSense、PHP Debugの二種の拡張機能をインストールしてください。
インストールした後、これらの設定などは特に必要ありません。
インストールが完了したらエディタを再起動してください。

 

launch.jsonの編集

いよいよデバッグの設定をします。
まずあらかじめに「ファイル」からデバッグ対象のプロジェクトフォルダを開いておいてください。

vscopen加工
その後、左サイドメニューから「デバッグ」を開き歯車ボタンを押します。
作成するファイルの種類を聞かれるので「PHP」を選択してください。

loauch加工
プロジェクトのルートディレクトリに「.vscode」フォルダが作られ、その中にlaunch.jsonが生まれます。

launchBorn加工
それを以下のように編集してください。

「ドキュメントルートのフルパス」というのはデバッグ対象のフォルダのパスです。
それに使われている「\(バックスラッシュ)」を二つに重ねてください。
例えば、デバッグ対象のフォルダのパスが
「 C:\xampp\htdocs\PHPDebugTest 」
だとします。
その場合は、
「 C:\\xampp\\htdocs\\PHPDebugTest 」
という風に記述してください。

lounch

こんな感じですね。

 

準備完了

これで準備完了です。

それでは実際の使い方をテストプロジェクトで説明していきましょう。
こんな感じのphpファイルを用意しました。

debugscript

それではまずサイドメニューからデバッグウィンドウを表示してください。
そしてデバッグウィンドウに「ブレークポイント」というタブがあります。

その中に様々な項目がありますが、今回はまず外しましょう。

次に、処理を確かめたい行の左あたりをクリックしてブレークポイントを設定します。
(赤い丸がついたら成功です)

の上、デバッグウィンドウで再生ボタンを押します。
(デフォルトでは再生中、下部のバーがオレンジ色になります。)

debug加工
その後、ブラウザから該当ページを表示してください。
そうするとブラウザの表示が止まり、タスクバー上でVisualStudioCodeが反応しているかと思います。

再度VisualStudioCodeを開くと、

結果
ブレークポイントで止まりましたね。
これで成功です。
詳しいデバッグの方法は、機会があればまたご説明させていただこうと思います。

 

おわりに

いかがでしたか?
初心者にとっては開発環境を整えるのって意外と大変だったり難しかったりしますよね。
この機会にphpのデバッグ環境をセッティングしてみましょう!

Share on Facebook0Tweet about this on TwitterShare on Google+0Email this to someone