PhpStorm 2018.3ヘルプ

クイック・スタート・ガイド

PhpStormは、IntelliJ IDEAプラットフォームの上に構築されたPHP開発者向けの統合開発環境です。

サポートされる言語

PhpStormでは、PHPバージョン5.3 / 5.4 / 5.5 / 5.6 / 7.0 / 7.1 / 7.2 / 7.3でアプリケーションを開発できます。さらに、HTML 5、CSS、JavaScript、およびXMLを完全にサポートしています。これらの言語はプラグインを介してIDEにバンドルされており、デフォルトで有効になっています。プラグインを介して他の言語のサポートを追加することもできます。設定/環境設定ダイアログ(Ctrl+Alt+S)で、プラグイン に移動して詳細を調べるか、最初のIDE起動時にそれらを設定します。

サポートされるプラットフォーム

PhpStormは、WindowsmacOS、およびLinuxで動作するクロスプラットフォームのIDEです。

PhpStormシステム要件

PhpStormを実行するには、最低1 GB RAM(2 GB RAM推奨)、最低1024 x 768の画面解像度が必要で、次のシステム要件に適合する必要があります。

32ビット版または64ビット版のMicrosoft Windows 10,8,7(SP1)、またはVista (SP2)
macOS 10.8.3以降 (64ビットシステムのみがサポートされています)
OS Linux(32ビットJDKはバンドルされていないため、64ビットシステムを推奨します)。KDE、Gnome、またはUnityデスクトップ環境を推奨します。

JRE 1.8はすべてのプラットフォーム用のディストリビューションにバンドルされています。つまり、PhpStormを実行するためには、マシンにJavaをインストールする必要はありません。

インストール要件のPhpStormの要件の詳細を確認してください。

PHP環境の設定

PhpStormはスマートなIDEですが、まずあなたが使用しているPHP環境、PHPコンポーネントが格納されている場所、およびそれらの設定方法を知らせる必要があります。

このクイック・スタート・ガイドでは、 Docker環境で事前設定されたプロジェクトをセットアップします。

始める前に

  1. ご使用のオペレーティング・システム用のDockerをインストールする(英語)

  2. PhpStormでは、設定/環境設定ダイアログ(Ctrl+Alt+S)を開きます。

  3. ビルド、実行、デプロイ | Dockerに移動し、Dockerデーモンへの接続方法を選択します。

    お使いのオペレーティングシステムに応じて、次の操作を行います。

    • TCP ソケットを選択します。

    • エンジン API URLtcp://localhost:2375に設定します。

    • 証明書フォルダーフィールドは空のままにします。

    Dockerツールボックスを使用している場合は、代わりに次の設定オプションを使用してください。

    • エンジン API URLhttps://192.168.99.100:2376に設定

    • 証明書フォルダー<your_home_directory>\.docker\machine\machines\defaultに設定します。

    • Mac用Dockerを選択します。

    • Unixソケットを選択します。

ステップ 1: PhpStormでプロジェクトを開く

PhpStormですることはすべて、プロジェクトのコンテキスト内で行われます。これは、コーディング支援、一括リファクタリング、コーディングスタイルの一貫性などの基盤として機能します。

このクイック・スタート・ガイドでは、事前設定された環境を持つ docker-compose.yml ファイルをすでに含んでいるワークショッププロジェクトを提供します。プロジェクトはhttps://github.com/JetBrains/phpstorm-workshop(英語)のGitHubで利用可能です。

PhpStormでWorkshopプロジェクトを開始する

  1. PhpStormようこそ画面で、新規プロジェクトの作成をクリックします。

    ps_workshop_materials_welcome_screen.png
  2. 左側のリストからPhpStorm ワークショップ・プロジェクトを選択し、ロケーションフィールドにプロジェクトの場所を入力して、作成をクリックします。

    ps_workshop_materials_create_workshop_project_from_new_project_dialog.png
  3. エディターで docker-compose.yml を開き、オペレーティングシステムに応じた値で XDEBUG_CONFIG 変数を更新します。これはWebデバッグに必要です。

    リモートホストを参照する host.docker.internal 値、つまりDockerが稼動しているマシンを使用します。ホストの内部アドレスに自動的に解決され、コンテナからホストの内部アドレスに接続されます。

    docker-compose.yml ファイルの対応する部分は、次のようになります。

    XDEBUG_CONFIG: remote_host=host.docker.internal

    リモートホストを参照する host.docker.internal 値、つまりDockerが稼動しているマシンを使用します。ホストの内部アドレスに自動的に解決され、コンテナからホストの内部アドレスに接続されます。

    docker-compose.yml ファイルの対応する部分は、次のようになります。

    XDEBUG_CONFIG: remote_host=host.docker.internal

    ローカルマシンのホスト名を使用します。それを取得するには、ターミナルで hostname コマンドを実行します。

    docker-compose.yml ファイルの対応する部分は、次のようになります。

    XDEBUG_CONFIG: remote_host=<local_hostname>
  4. 同じ docker-compose.yml ファイルで、オペレーティングシステムに応じて sftp サービスの適切な行のコメントを外します。これはデプロイが正しく機能するために必要です。

  5. エディターガターで Start services button をクリックして、必要なDockerコンテナをすべて開始します。

    Start containers button

    または、内蔵PhpStorm端子(Alt+F12)を開いて docker-compose up コマンドを実行してください。

ようこそ画面から見ることができるように、PhpStormでプロジェクトを開始するための他のオプションがあります。

ps_quick_start_welcome_screen_mac.png

ステップ 2: ユーザーインターフェースを調べる

PhpStormのメインウィンドウは、いくつかの論理領域に分かれています。

ps_quick_start_user_interface_mac.png
  1. メニューツールバーは、さまざまなコマンドを実行できます。

  2. プロジェクトをナビゲートするためのナビゲーション・バー

  3. ステータス・バーには、PhpStorm全体、現在のプロジェクト、エディター内のファイル、警告、およびエラーメッセージに関するさまざまな情報が含まれています。

  4. 実際にコードを書くエディター。開いているファイル間を簡単に移動するためのタブがあります。

  5. さまざまな機能を実行する数多くのツール・ウィンドウ:プロジェクトやファイル構造の探索とナビゲーション、検索とインスペクションの結果の表示、アプリケーションの実行、デバッグ、テスト、インタラクティブコンソールでの作業などを手助けします。

ステップ 3: スマートアシスタンスによるコード

PhpStormはルーチンを処理し、重要なものに集中できるようにします。多くのPhpStormコーディング機能を使用して、無駄な時間を無駄にせずにエラーのないアプリケーションを作成できます。基本プロジェクトでは、コード例とガイドラインを使って、多数のPHPファイルでこれらの機能をインタラクティブに試すことができます。

コード補完

コード補完は、作業中のファイルの種類に関係なく、非常に時間を節約します。PhpStormには、基本スマートの 2種類のコード補完があります。

基本補完Ctrl+Space)は、現在のコンテキストのコード補完オプションを表示し、現在のタイプのメンバーを太字で表示します。

ps_quick_start_basic_completion_mac.png
より多くのバリアントを表示するには、もう一度 Ctrl+Space を押します。

基本コード補完を試すには、プロジェクトで workshop/02_Editing/01_Completion/1.1_Basic_Completion.php を開き、コメントの指示に従ってください。

スマート補完Ctrl+Shift+Space)は現在作業しているコンテキストを分析し、その解析に基づいてより正確な提案を提供し、式のタイプに一致する関数と変数のリストをフィルタリングします。

スマートコード補完を試すには、プロジェクトで workshop/02_Editing/01_Completion/1.3_Type_hinting.php を開き、コメントの指示に従ってください。

インテンション・アクション

PhpStormはあなたが現在何をしているのかを見張っていて、時間をもっと節約するためにインテンションアクションと呼ばれるスマートな提案をします。インテンションアクションを使用すると、正しいであるコードに自動変更を適用できます(間違っているかもしれないであるコードにクイックフィックスを提供するコードインスペクションとは対照的に)。

コードは存在しないファイルを参照していますか? PhpStormには問題ありません: Alt+Enter を押してファイル<ファイル名>を作成します。を選択します:

ps_quick_start_intention_action_1_1_mac.png

使用可能なインテンションアクションの全リストを表示するには、設定/環境設定ダイアログ(Ctrl+Alt+S)でエディター | インテンションに移動します。

さまざまなインテンション・アクションを試すには、プロジェクトで workshop/02_Editing/05_Intentions/5.1_Intentions.php を開き、コメントの指示に従います。

ステップ 4: コードをきれいに保つ

PhpStormはあなたのコードを監視し、正確かつきれいに保ちます。潜在的なエラーと問題を検出し、クイック・フィックスを提案します。

PhpStormは、使用されていないコード、無限ループ、隠された上部スコープ、条件式の代入演算子 = 、およびおそらくあなたの注意を必要とする多くのものを見つけるたびに、電球を見るでしょう。それをクリックするか、 Alt+Enterを押して修正を適用します。

useの声明を忘れましたか?

ps_quick_start_inspection_mac.png
Alt+Enter を押し、クラスのインポートをクリックします:
ps_quick_start_import_class_popup_mac.png
リストで、インポートするクラスをクリックします。
ps_quick_start_quick_fix_choose_class_to_import_mac.png
PhpStormは、選択したクラスをインポートし、useステートメントを追加します。
ps_quick_start_quick_fix_class_imported_use_added.png
workshop/03_Inspections/02_Quick_Fixes.phpから実際のサンプルを試してみてください。

利用可能なインスペクションの全リストを見るには、設定/環境設定ダイアログ(Ctrl+Alt+S)でエディター | インスペクションに移動します。それらのいくつかを無効にしたり、他のものを有効にしたりすることができ、さらに各インスペクションの重大度を調整することができます。それをエラーと見なすべきか、単なる警告と見なすべきかを決めます。

ステップ 5: いくつかのコードを生成する

PhpStormで利用可能なコード生成オプションを使用すると、コードを書くのがはるかに簡単で速くなります。コード | 生成メニュー(または単に Alt+Insert)は、コンストラクタ、ゲッター/セッター、PHPDocコメントの生成を手助けします。また、いくつかのメソッド(Ctrl+O / Ctrl+I)のオーバーライド/実装を提案します。 workshop/02_Editing/06_Generate_code/6.1_Generate_Code.phpでもっとライブの例を試してみてください。

ps_quick_start_generate_code_mac.png

ライブ・テンプレートコード | ライブ・テンプレートの挿入を選択するか Ctrl+Jを押す)を使用してコード構造全体を生成します。使用可能なライブテンプレートのリストを表示するには、設定/環境設定ダイアログ(Ctrl+Alt+S)でエディター | ライブ・テンプレートに移動します。

開発に重要なことが必要な場合は、独自のテンプレートでこのテンプレートセットを拡張します。 workshop/04_Live_Templates/01_Code_Expansion/1.1_Code_Expansion.phpworkshop/04_Live_Templates/02_Creating_Live_Templatesのライブサンプルを試してみてください。

また、コードを完全な構成要素で囲むことを検討してください。コード | 囲むを選択するか Ctrl+Alt+Tを押して、ポップアップメニューから必要なステートメントを選択します。 workshop/04_Live_Templates/03_Surround_Templates/3.1_Simple_template.phpでもっとライブの例を試してみてください。

ps_quick_start_surround_with_dialog_mac.png

ステップ 6: 方法を見つける

プロジェクトが大きい場合、または他の人が書いたコードを使用しなければならない場合は、探しているものを素早く見つけてコードを詳しく調べることが重要です。PhpStormがあなたがコードを通してあなたの道を見つけるのを助けるであろう一連のナビゲーション機能を備えているのはこのためです。

基本的な検索

プロジェクトで特定のシンボルが使われている場所を見つけるために、PhpStormは使用箇所の検索Alt+F7)を使って本格的な検索を提案しています:

ps_quick_start_find_usages_mac.png
また、現在のファイル(Ctrl+F)、ディレクトリー、任意のスコープ、またはプロジェクト全体(Ctrl+Shift+F)でのみ検索することもできます。

基本的な検索を試すには、プロジェクトで workshop/01_Navigation/05_Find_usages/5.2_Find_Usages.php または workshop/01_Navigation/05_Find_usages/5.1_Highlight_Usages_in_File.php を開き、コメントの指示に従います。

プロジェクトのナビゲーション

インポートや呼び出しの階層を使ってファイル構造を見ているだけで多くのことを知ることができ、強力なナビゲーション操作の助けを借りてコードをナビゲートすることができます。

  • どこでも検索を使用すると、クラス、ファイル、シンボル、およびメニューアクションを一度に検索し、それらにナビゲートすることができます。どこでも検索を起動するには、PhpStormウィンドウの右上隅にある虫めがねアイコン search_everywhere をクリックするか、 Shift を2回押します。検索パターンを指定しない場合、PhpStormは最新のファイルのリストを表示します。ここで、関連する項目に移動することができます。

    ps_quick_start_search_everywhere_1.png

    特定のものを検索するには、検索パターンを入力します: シンボルの他に、どこでも検索はアクションを見つけることができます:

    ps_quick_start_search_everywhere_specify_pattern_mac.png

    どこでも検索モードでは、PhpStormはキャメルハンプを受け入れて、真ん中のマッチを認識します。

    どこでも検索を使用するさまざまな方法を試すには、プロジェクトで workshop /01_Navigation/01_Navigate_to_something_you_know/1.6_Search_everywhere.md を開き、指示に従います。

    もちろん、クラスCtrl+N)、ファイルCtrl+Shift+N)、またはシンボルCtrl+Shift+Alt+N)の名前でナビゲートすることもできます。名前でターゲットを検索するを参照してください。

  • 宣言に移動(WindowsおよびLinuxの場合はCtrl+B、macOSの場合は ⌘+Click )を使用すると、特定のシンボルが最初に宣言されている場所に移動できます。この種類のナビゲーションは、ソースコード内の任意の場所から、他のクラスやコメントからであっても機能します。宣言に移動をナビゲートするには、プロジェクトで workshop/01_Navigation/02_Navigate_to_Declaration/2.1_Go_to_declaration.php を開き、コメントの指示に従ってください。

  • 実装に移動Ctrl+Alt+B)は特定のクラスの実装を紹介します。複数の実装がある場合、PhpStormはそれらをリストに表示し、そこから関連するものを選択してナビゲートできます。実装に移動をナビゲートするには、プロジェクトで workshop/01_Navigation/04_Navigate_class_hierarchies/4.1_Go_to_Implementation.php を開き、コメントの指示に従ってください。

    ps_quick_start_go_to_implementation_mac.png

タイムラインをナビゲートする

PhpStormは、ローカル・ヒストリーのソースコードの変更、リファクタリングの結果などを自動的に追跡します。従来のバージョンコントロールシステムとは異なり、ローカル・ヒストリーは常に有効です。ファイルまたはフォルダーを表示するには、メインメニューでVCS | ローカル・ヒストリー | ヒストリーの表示を選択します。変更内容を確認したり、元に戻したり(Rollback changes button)、パッチ(iconCreatePatch.png)を作成することができます。

ps_quick_start_local_history_mac.png

ローカル・ヒストリーを自分で試してみるには、プロジェクトで workshop/09_Version_Control/07_Local_History.php を開き、コメントの指示に従ってください。

ステップ 7: アプリケーションをデバッグする

アプリケーションは、意図されているものとまったく同じですか?そうでない場合は、問題の原因を突き止めるためにデバッグを行う必要があります。幸いにも、サンプルプロジェクトには既にXdebugがインストールされ、設定されています。

PHPインタープリターを設定する

プロジェクトでは、Docker環境にはすでにPHPインタープリターが含まれています。PhpStormには、その場所を伝えるだけで済みます。

  1. 設定/環境設定ダイアログ(Ctrl+Alt+S)で、言語とフレームワーク | PHPに移動します。

  2. 開いているPHPページで、CLI インタープリターリストからPHP 7.1とXdebugを選択します。

ブレークポイントの設定

デバッグは、プログラムの実行を中断するブレークポイントを配置することから始まり、プログラムデータを探索することができます: ブレークポイントを表示させたい行の左のガターをクリックするだけです:

ps_quick_start_set_breakpoints_mac.png

ブレークポイントを自分で演奏するには、プロジェクトで workshop/06_Debugging/03_Breakpoints.php を開き、コメントの指示に従います。

デバッグを開始する

プロジェクトツールウィンドウで、 workshop/06_Debugging/03_Breakpoints.php を選択し、コンテキストメニューでデバッグ| 03_Breakpoints.phpを選択します。

ps_quick_start_guide_start_debugging_session_mac.png

PhpStormはデバッグセッションを開始し、一時停止したプログラムをステップ実行し、変数値を表示したり、式を評価したりすることができるデバッグツールウィンドウを開きます。 workshop/06_Debugging/05_Debug_Tool_Window.phpから実際のサンプルを試してみてください。

代替のデバッグシナリオについては、ゼロコンフィギュレーションデバッグも参照してください。

ステップ 8: コードをテストする

PhpStormは、最も一般的なPHPテストフレームワーク(PHPUnitBehatPHPSpecCodeceptionなど)と統合されています。

テストを書く

テストするクラスに移動し、 Ctrl+Shift+Tを押します: ポップアップリストから新規テストの作成を選択します:

ps_quick_start_go_to_test_popup.png
開いているダイアログボックスで、すべてのフィールドが入力されるため、OKをクリックしてください。PhpStormはテストクラス <class_to_test>Test を生成し、それをエディターで開きます。必要に応じてテストを書く。

PhpStormコーディングアシスタンスでテストを書くには、 workshop/08_Testing/01_Writing_Tests.php を開き、コメントの指示に従ってください。

テストを起動する

テストを含むファイルをエディターで開くか、プロジェクトツールウィンドウでクリックして<class_to_test>テストを実行するを選択します。これにより、PhpStormが自動的に生成したPHPUnit実行設定が起動します。BehatPHPSpec、またはCodeceptionタイプの実行構成(実行 | 構成の編集)を作成し、それをツールバーのドロップダウンリストから選択して、 Run buttonをクリックすることもできます。PhpStormは実行ツール・ウィンドウテストランナータブの結果を示しています。

Test runner tab.png

ステップ 9: ソースコードをバージョン管理下に置く

ソースコードをバージョン管理下に置いている場合は、PhpStormが多くの一般的なバージョン管理システム (Git(またはGitHub)、Mercurial、Perforce、TFS、Subversion、およびCVS)と統合されていることを知って喜んでいただけるでしょう。資格情報および特定のVCSに固有の設定を指定するには、設定/環境設定ダイアログ(Ctrl+Alt+S)でバージョン管理に移動します。

VCSメニューは、利用可能なコマンドについての手がかりを与えます。例:変更のポップアップビュー(VCS | 変更点の表示または Alt+9)から、変更を確認し、コミットしたり、チェンジリストを作成したりできます。

ステップ 10: 以上です!先に進んで楽しみながら開発してください!

PhpStormの重要な機能の概要を簡単に紹介していただければ幸いです。開発者の生活をより簡単で楽しくし、ソースコードをきれいにする重要な機能はたくさんあります。これらの最初のいくつかのステップを今すぐ行い、次に時間が正しいと感じると深く掘り下げてください。PhpStormをお楽しみください!

ご質問がありましたら、PhpStormディスカッションフォーラム(英語)twitter(英語)blog(英語)をご覧ください。ニュース、アップデート、役立つヒントやコツが掲載されています。また、サポートチームまたはPhpStorm issue trackerに(英語)問題を報告してください。

最終更新日: 2019年2月15日