PhpStormの使い方

Tag:

PhpStormの使い方について紹介します。「主なショートカット」や「便利機能」など取り上げています。

※Mac上で作業してます。

新規プロジェクト作成

次の作業を行ったフォルダをPhpStormのプロジェクトにしてみます。

1. composerでLaravelをインストール
2. gitコマンドでリポジトリ作成、リモートリポジトリ登録

1. PhpStormを開き、[Create New Project]をクリック。

2. 赤枠箇所をクリックしてLaravelのフォルダを指定。createをクリック。

3. 既に存在するフォルダ上でプロジェクトを作成してもよいか聞かれます。Yesをクリック。

以上でPhpStormのプロジェクトが作成されます。

PhpStormプロジェクトを作成したことによって、laravelフォルダ配下に「.ideaフォルダ」が生成されました。このフォルダ内にPhpStormの設定情報が保存されます。プロジェクトをgitで管理している場合は、.gitignoreに追加しておくと良いです。

カラースキーマーの設定

背景を黒くしたい場合の設定を紹介します。
まず、[Preferences] – [Appearance] をクリックします。
[UI Options]内の[Theme]で「Darcula」を選択すると黒くなります。

VCSのカラーを変更

デフォルトで、変更した箇所など判断できるように、対象行のgutter(脇部分)に色がつきます。しかし、色が薄くて判断しづらいです。VCSのカラーを変更するには以下のようにします。
1. [PhpStorm]-[Preferences]で設定を開きます。
2. [Editor]-[Colors & Fonts]-[VCS]を選択。
3. Editor Gutterで対象の変化に対するBackgroudの色を設定。

コーディング規約の設定

1. [PhpStorm]-[Preferences]で設定を開きます。
2. [Editor]-[Code Style]-[PHP]を選択します。
3. プロジェクトのみに設定したい場合、Schemeを「Project」にします。Set from…をクリックして[PSR1/PSR2]を選択します。

これで「Reformat Code」を実行するとPSR1/PSR2に従って整形されます。

ディレクトリの役割を設定

1. [PhpStorm]-[Preferences]で設定を開きます。
2. [Directories]を選択します。
3. 対象のディレクトリを選択して、「Tests」や「Resource Root」を指定します。

htmlでimgなどのファイルを指定する際、「Resource Root」を指定したディレクトリを起点として対象ファイルの候補表示をしてくれます。

PhpStormの機能を実行する3つの方法

例として「Reformat Code」を実行してみます。

方法1. ナビゲーションから選択して実行

メニューから[Code]-[Reformat Code]を選んでクリックして実行します。

方法2. Find Action上で機能を入力して実行

[command + shift + A]でFind Actionを呼び出し、目的の機能を入力して実行します。

方法3. ショートカットで実行

「Reformat Code」は[option + command + L]で実行できます。
よく使う機能から少しずつショートカットを使うようにすると作業が捗るかと思います。

主なショートカット

[Help]-[Keymap Reference]でショートカット一覧を確認できます。よく使いそうなショートカットを取り上げます。

Editing

ショートカット 説明 補足
control + space Basic code completion コード補完。ただし、MacだとSpotlightのショートカットとかぶります。
control + J Quick documentation lookup 選択したクラス、変数、メソッドのドキュメント表示。
control + O Override methods 現在のクラスでオーバライドできるメソッド一覧が表示されます。
command + / Comment/uncomment with line comment コメントアウトしたいコードを選択状態でクリック。
command + option + / Comment/uncomment with block comment コメントアウトしたいコードを選択状態でクリック。
command + option + L Reformat code
command + W Close active editor tab
command + shift + V Paste from history 過去の貼付履歴から選択して貼付できます。

Search/Replace

ショートカット 説明 補足
command + F/R Find/Replace Escで非表示。
改行置換したいときは「\r」
command + G/shift + G Find next/previous
command + shift + F/R Find/Replace in path ディレクトリを指定して検索できます。

Navigation

ショートカット 説明 補足
command + E Recent files popup 最近開いたファイル履歴を表示。
command + option + (← or →) Navigate back/forward
command + B
または
command + Click
Go to declaration クラス、変数、メソッドの定義元にジャンプ。

General

ショートカット 説明 補足
shift2回 Search everywhere ファイルやクラス検索とかに使ってます
shift + command + A Find Action
command + , Open Settings dialog

この他に私がよく使うショートカットです。

ショートカット 説明 補足
Command + 数字 パネルの表示・非表示 1:Project
7:Structure
6:Todo
9:Version Control
のように書いてあるので数字は覚えなくてOK
Command + Delete 現在の行削除
Command + D 現在の行をコピーして下の行に挿入
Command + Option + T 選択範囲を囲むようにタグをつけたいときなどに利用
Command + K Commit Directoryを開く
src属性にフォーカスした状態でshift imageのプレビューができる

プラグイン

個人的に利用しているプラグイン。

Native Neighbourhood

編集中のファイルが存在するディレクトリをFinderやターミナルで即座に開くことができる。
Toolsにメニューが追加されます。

.ignore

.gitignoreで利用。無視されたファイルのカラーが変わる。

Scratch

適当なファイルを作成して、どこからでも呼び出せる。

・新規作成
「option + C」 の後に「option + A」

・作成したファイルのリスト表示
「option + C」 の後に「option + S」

Vue.js

.vueファイルのコードハイライト。

Laravel Plugin

下記サイトで詳しく説明してくださっています。
http://blog.comnect.jp.net/blog/119

なお、Laravelを利用する際には、プロジェクトごとに下記設定を行っておきます。
1. [PhpStorm]-[Preferences]で設定を開きます。
2. [Languages & Frameworks] – [PHP] – [Laravel]でチェックをつけてApply。

Xdebugの設定(ローカル実行)

ローカルでXdebugを利用する場合、まず、xdebugをインストールします。

// インストールしているphpのバージョン確認
php -v

// 対象バージョンのxdebugをインストール
brew search xdebug
brew install php70-xdebug

// iniファイル修正(後述)
php -i|grep php.ini
vi /usr/local/etc/php/7.0/conf.d/ext-xdebug.ini 

// xdebugがモジュールとして追加されているか確認
php -m

iniファイルは、とりあえず、次のように記述。

[xdebug]
zend_extension="/usr/local/opt/php70-xdebug/xdebug.so"

xdebug.remote_enable=1
xdebug.remote_port="9000"

phpstormの設定を開き、「CLI Interprter」を設定します。


これで、ローカルでxdebugが利用できます。

参考

https://www.jetbrains.com/help/phpstorm/2016.3/configuring-xdebug.html
https://www.jetbrains.com/help/phpstorm/2016.3/cli-interpreters.html

Xdebugの設定(Webアプリ)

LaravelなどのWebアプリでXdebugを利用したい場合の設定です。

1. [Run] – [Edit Configrations]
2. 左上のプラスボタンをクリックして、[PHP Web Application]を選択

3. Serverを設定するため[…]をクリック

4. [Name][Host][Port]を設定

5. [Name][Start URL]を設定

6. 作成したDebugを起動

その他

todo

TODOと残しておくと、後でTODO一覧を確認できる。

ライブラリなどに書かれているTODOなども表示されるので、TODOパターンはカスタマイズして利用すると良いです。
環境設定の[Editor]-[TODO]からパターンを追加できます。

ターミナル

プラスボタンでタブを増やしたり、[command + F]での検索もできます。

Test RESTfull Web Service

[Tools]-[Test RESTfull Web Service]で内蔵されている「REST Client」によるテストができます。

LocalHistory

編集ログが自動で残る。

zencording

デフォルトで利用可能。

矩形選択

optionを押しながら範囲選択。

phpDoc

/**[ENTER]とすることでDocの補完ができる。

スポンサーリンク