PhpStorm 2024.1 ヘルプ

Robo

PhpStorm を使用すると、IDE から Robo PHP タスクランナー(英語)のコマンドを直接実行できます。

Robo がプロジェクトにインストールされ初期化されている場合、PhpStorm は RoboFile.php ファイルの内容を解析し、RoboFile クラスのパブリックメソッドを実行可能コマンドとして検出し、専用の Robo タスクツールウィンドウに表示します。あるいは、RoboFile.php ファイル内のメソッドをエディターから直接実行することもできます。

Robo overview in PhpStorm
Robo overview in PhpStorm

PhpStorm は、呼び出された Robo コマンドのデフォルトの実行構成を作成し、それを実行して、出力を実行ツールウィンドウに表示します。

Robo run tool window

Robo のインストールと初期化

PhpStorm で Robo を使用するには、Composer を使用してプロジェクトに Robo ライブラリをインストールする必要があります。

  1. composer.json 内で、consolidation/robo 依存関係レコードを require キーまたは require-dev キーに追加します。パッケージ名とバージョンのコード補完を取得するには、Ctrl+Space を押します。

    { "require-dev": { "consolidation/robo": "^4.0.3" } }
  2. 次のいずれかの方法で、composer.json からプロジェクトに依存関係をインストールします。

    • エディターパネルの上部にあるインストールショートカットリンクをクリックします。

    • インストールされていない Composer パッケージインスペクションが有効になっている場合、PhpStorm は、現在インストールされていない宣言済みの依存関係をハイライトします。Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。

  3. ターミナルツールウィンドウで robo init コマンドを実行して、RoboFile.php ファイルをプロジェクトルートに追加します。

    RoboFile.php にコマンドを追加する方法については、Robo のドキュメント(英語)を参照してください。

PhpStorm で Robo タスクを実行する

次のいずれかの方法で、PhpStorm で Robo コマンドを実行できます。

  • Robo タスクツールウィンドウのリスト上のコマンドをダブルクリックします。Robo タスクツールウィンドウを開くには、サイドバーの Robo タスクバーを選択するか、メインメニューから表示 | ツールウィンドウ | Robo タスクを選択します。

    Robo tasks tool window
    Robo tasks tool window
  • RoboFile.php ファイルから。エディターで RoboFile.php を開き、必要なメソッドの横にあるガターで をクリックし、コンテキストメニューから実行 'Robo task <name>' を選択します。

  • なんでも実行アクション。Ctrl を 2 回押してなんでも実行ポップアップを開き、そこに Robo コマンド名を入力します。

    Run Robo with Run Anything

Robo の実行構成を管理する

PhpStorm の他の実行 / デバッグ構成と同様に、Robo の実行構成を永続的に保存共有テンプレートから作成フォルダーにグループ化、または後で使用するために保存することができます。

カスタム Robo 実行構成を作成する

カスタム Robo 実行構成を作成することも、既存のデフォルト構成を編集することもできます。

  1. 実行 | 実行構成の編集に進みます。あるいは、ツールバーのリストから実行構成の編集を選択します。

    Open the Edit Configurations dialog

    開いた実行構成の編集ダイアログで、ツールバーの追加ボタン (the Add button) をクリックし、リストから Robo を選択します。

    最新の実行構成を編集するには、実行ツールウィンドウのツールバーで をクリックします。

  2. 開いた Robo の設定ダイアログで、次のように Robo 固有の設定を入力または編集します。

    ファイル

    robo 実行可能ファイルへのパス。PhpStorm はデフォルトで、vendor/bin フォルダー内の robo ファイルへのパスを設定します。

    引数

    Robo コマンド名と、引数を持つ Robo メソッドが次の形式で定義される RoboFile.php ファイルへのパス: <command name> --load-from <path to RoboFile.php>

    Robo run configuration dialog

    一般的な実行構成設定の構成の詳細については、「実行 / デバッグ構成ダイアログ」を参照してください。

Robo 構成を起動タスクとして実行する

  • 定期的に実行する Robo タスクがある場合は、対応する実行構成をスタートアップタスクの設定起動タスクのリストに追加できます。追加されたタスクは、プロジェクトが起動するたびに自動的に実行されます。

関連ページ:

実行ツールウィンドウ

実行ツールウィンドウには、アプリケーションによって生成された出力が表示されます。各タブの外観は、実行中のアプリケーションの種類によって異なり、追加のツールボックスとペインを含めることができます。Vue.js アプリケーションをデバッグする、Angular アプリケーションをデバッグする、Vite アプリケーションをデバッグする、React アプリケーションをデバッグするから詳細を学びます。ツールウィンドウのタブ:タブをピン留め複数のアプリケーションを実行している場合、各アプリケーションは、適用...

Composer 依存関係マネージャー

PhpStorm は Composer 依存関係マネージャーと統合されています。これにより、Packagist またはカスタムリポジトリからのパッケージをプロジェクトの依存関係として宣言し、IDE から管理できます。PhpStorm は以下を提供します。一般的な Composer コマンド (init、install、update、および多数の追加 Composer コマンド) を実行するための専用ユーザーインターフェース。コマンド出力は Composer ログコンソールに表示されます。PhpStorm...

ローカル PHP インタープリターを構成する

ローカル PHP インタープリターは、リモートホスト、Docker コンテナー、または Vagrant 仮想環境にインストールされるリモート PHP インタープリターとは対照的に、コンピューターにインストールされる PHP エンジンです。ローカル PHP インタープリターを構成するを押して設定を開き、を選択します。表示される PHP ページで、CLI インタープリターリストの横にあるをクリックします。表示される CLI インタープリターダイアログで、左側のペインのをクリックして、ポップアップメニュー...

リモート PHP インタープリターの構成

リモート PHP インタープリターという用語は、リモートホストまたは仮想環境にインストールされた PHP エンジンを指します。リモート PHP インタープリターという用語は、コンピューターにインストールされているローカル PHP インタープリターの対義語として使用されます (ローカル PHP インタープリターの構成を参照)。SSH、Docker、Docker Compose、Vagrant、WSL を介してリモート PHP インタープリターにアクセスできます。SSH を使用すると、PHP インター...

実行 / デバッグ構成

PhpStorm は、実行 / デバッグ構成を使用して、コードを実行、デバッグ、テストします。各構成は、何を実行し、どのパラメーターと環境を使用するかを定義する、名前付きのスタートアッププロパティのセットです。実行 / デバッグ構成には 2 つのタイプがあります。一時的 — コンテキストメニューからを選択するたびに作成されます。コンテキストメニューを呼び出すには、オブジェクトまたは領域を右クリックします。永続的 — テンプレートから明示的に作成されるか、一時的な構成を保存することによって作成されま...

Rector

PhpStorm は、デフォルトで IDE にバンドルされ有効になっている Rector プラグインに基づく PHP コードのアップグレードとリファクタリング機能をサポートします。Rector は、自動リファクタリングとアプリケーションの新しいフレームワークまたは PHP バージョンへのアップグレードのためのコード変換ルールを提供します。PhpStorm を使用すると、プロジェクトツールウィンドウから直接、選択したフォルダーまたはファイルに対して Rector ルールを実行し、差分ビューアーでソース...