Github CodespacesでPHPの開発・デバッグ環境の作り方

Shuji MIYOSHI

GitHub Codespacesを使ってPHPの開発およびデバッグ環境を構築する方法は以下の通りです。

  1. GitHubにリポジトリを作成: まずはじめに、GitHubで新しいリポジトリを作成します。

  2. コードスペースを開く: リポジトリページにアクセスし、右上の「Code」ボタンの隣にある「Open with Codespaces」をクリックし、新しいコードスペースを開きます。

  3. PHPの設定: 次に、PHPの開発およびデバッグに必要なツールをインストールします。ターミナルに以下のコマンドを入力してください。

sudo apt-get update
sudo apt-get install php php-cli php-zip unzip php-mbstring php-xml php-curl

Visual Studio Code拡張機能のインストール: PHP開発に適した拡張機能をインストールします。左側のアイコンから拡張機能ペインを開き、「PHP」と検索して、以下の拡張機能をインストールしてください。

  • PHP IntelliSense

  • PHP Debug

  • PHP Formatter

  1. デバッグ設定: PHP Debug拡張機能を使用してデバッグ環境を設定します。次の手順に従ってください。

  • まず、左側のアイコンからデバッグペインを開きます。

  • 「create a launch.json file」をクリックします。

  • 環境として「PHP」を選択してください。

これにより、デバッグ用のlaunch.jsonファイルが作成されます。次に、以下の内容でlaunch.jsonを編集してください。

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": 9003
        },
        {
            "name": "Launch currently open script",
            "type": "php",
            "request": "launch",
            "program": "${file}",
            "cwd": "${fileDirname}",
            "port": 9003
        }
    ]
}

Xdebugインストール: ターミナルで次のコマンドを実行して、Xdebugをインストールしてください。

sudo apt-get install php-xdebug

Xdebug設定: インストールが完了したら、Xdebugの設定を行います。/etc/php/7.x/cli/conf.d/20-xdebug.iniファイルを作成または編集し、以下の内容を追加してください。7.xの部分はインストールされているPHPのバージョンに応じて変更してください。

zend_extension=xdebug.so
xdebug.mode=debug
xdebug.start_with_request=yes
xdebug.client_host=127.0.0.0.1
xdebug.client_port=9003
xdebug.log=/tmp/xdebug.log

このコマンドは、127.0.0.1アドレスの8000ポートでPHPサーバーを起動します。異なるアドレスやポートを使用する場合は、適宜変更してください。

  1. デバッグの開始: デバッグペインで「Listen for Xdebug」または「Launch currently open script」を選択し、「デバッグの開始」アイコンをクリックします。これにより、デバッグセッションが開始されます。

  2. ブレークポイントの設定: コード内の任意の行にブレークポイントを設定して、その行でデバッグセッションを停止させることができます。ブレークポイントを設定するには、行番号の左側をクリックします。

以上で、GitHub CodespacesでPHPの開発およびデバッグ環境を構築する方法が完了しました。これで、コードスペースでPHPの開発とデバッグが行えるようになります。

以下に、簡単なデバッグができるPHPコードのサンプルを示します。このコードは、与えられた整数の階乗を計算し、結果を表示します。

<?php

function factorial($number) {
    if ($number < 2) {
        return 1;
    } else {
        return $number * factorial($number - 1);
    }
}

$number = 5;
$result = factorial($number);

echo "The factorial of {$number} is {$result}.\n";

このコードをデバッグするには、以下の手順に従ってください。

  1. まず、上記のコードをfactorial.phpという名前のファイルに保存します。

  2. Visual Studio Codeでfactorial.phpファイルを開きます。

  3. ブレークポイントを設定するために、factorial()関数の定義行（この例ではfunction factorial($number) {）の行番号の左側をクリックします。

  4. デバッグペインで、「Listen for Xdebug」または「Launch currently open script」を選択し、「デバッグの開始」アイコンをクリックします。これにより、デバッグセッションが開始されます。

  5. PHPサーバーを起動し、コードを実行します。ターミナルで次のコマンドを実行してください。

php -S 127.0.0.1:8000 factorial.php

デバッグセッションが開始され、ブレークポイントで停止します。この状態で、変数の値を確認したり、ステップオーバー、ステップイン、ステップアウトなどのデバッグ操作を実行できます。


この記事が気に入ったらサポートをしてみませんか？