PHP VSCode ユーザスニペット設定方法【私の使用している設定を公開】

私は最近、PHPをメインで開発をしており、IDEにVSCodeを使用しています。

VSCodeにはユーザスニペットという機能があり、ここに登録しておいたものをTAB補完で簡単に呼び出せるという機能があるんです。便利！

ユーザユニペットの設定方法

まず、ヘッダメニューから

ファイル　＞　基本設定　＞　ユーザースニペットを選択します。

今回は、phpの設定をするため、php.jsonを開きましょう。

こちらに設定を記述していきます。

"name": {
		"prefix": "test",
		"body": [
		  "echo 'test';",
		],
	  },

サンプルとして書きましたが、こんな感じに設定します。

name部分については、なんでも良いです。

自身のわかりやすい名前で、他のnameと被らないように設定して下さい。

prefixは、呼び出し文字です。

この場合だと、testと入力した時点で、TABを押すと、echo 'test';という文字に置き換えられます。

要するに辞書登録みたいなものですね。

良く使用する文章がある場合は、こちらに登録しておくと作業効率がぐんっと向上します。

私が使用しているユーザスニペット設定

PHP歴が全然長くないため、そんなに参考にはならないかもですが...。

{
	"dump": {
		"prefix": "va",
		"body": [
		  "var_dump();",
		],
	  },
	"request": {
	"prefix": "re",
	"body": [
		"var_dump($$this->request->data);",
	],
	},
	"log": {
		"prefix": "getlog",
		"body": [
			"/////////////////debug////////////////////////////",
			"ob_start();",
			"var_dump($$test);",
			"$$out = ob_get_contents();",
			"ob_end_clean();",
			"file_put_contents('/var/log/error_log', $$out, FILE_APPEND);",
			"/////////////////debug////////////////////////////",
		],
		},
	"set": {
		"prefix": "set",
		"body": [
					"$$this->set(compact('aaa'));",
		],
		},
	"data": {
		"prefix": "data",
		"body": [
					"$$data = $$this->request->data;",
		],
		},
}

こんな感じです。

「request」「data」「set」という名前で登録されているものは、cakePHPで使用するものです。

その他は、デバッグ系の記述ですね。