VSCode|PHP用スニペットのカスタマイズメモ

VSCode用のユーザースニペット編集メモです。

php.jsonを開くには？
スニペットサンプル
1. PHP
ユーザースニペットの書き方
スニペットのタブストップと予測変換干渉の対処
参考

php.jsonを開くには？

ファイル＞ユーザー設定＞ユーザースニペットの構成＞php.jsonを選択します。

{
	// Place your snippets for php here. Each snippet is defined under a snippet name and has a prefix, body and 
	// description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the 
	// same ids are connected.
	// Example:
	// "Print to console": {
	// 	"prefix": "log",
	// 	"body": [
	// 		"console.log('$1');",
	// 		"$2"
	// 	],
	// 	"description": "Log output to console"
	// }

//ここに必要なものを追加
}

スニペットサンプル

各言語でのVSCodeスニペットのサンプルの紹介です。

PHP

class & spl_autoload_register

{
	"class":{
		"prefix": "class",
		"body":[
			"class ${1:$TM_FILENAME_BASE}",
			"{",
			"\t$0",
			"\\}"
		]
	},
	"autoload":{
		"prefix": ["spl_autoload_register", "autoload"],
		"body": [
			"spl_autoload_register(function (\\$class_name) {",
			"\tinclude './${1:folder/}' . \\$class_name . '.php';",
			"});",
			"$0",
		],
	},
}

1)ファイル名と同じクラス名をデフォルトで付けるクラス。

2)クラスが存在しなかった場合に、そのクラス名を引数としたコールバックを呼び出す
“spl_autoload_register”のスニペット。

ユーザースニペットの書き方

例としてhtml.json上のphpタグとそのechoタグのスニペットは以下のようになります。

{
	"php tag":{
		"prefix":"<?php ?>",
		"body":[
			"<?php",
			"$0",
			"?>"
		],
		"description": "php tag"
	},
	"php echo":{
		"prefix": "<?php echo '' ?>",
		"body": [
			"<?= $1 ?>$0"
		],
		"description": "php echo (short)"
	}
}

“prefix”:実際に入力するキー（途中まで入力すれば候補に表示される）
“body”:表示されるスニペット
“description”:ユーザースニペットの補足説明

スニペットのカーソル位置を指定する

$1, $2のように$に番号を付ける事でタブ(Tab)キーで移動できるカーソル位置の指定,
$0で最後のカーソル位置を指定出来ます。

また同じ$番号を複数使用する事で、同時に複数のカーソルを使用できます。
これはスニペット内のCtrl+Shift+L相当で”for文の$i”等に利用できます。

タブ（Tab）を挿入する

\t

（$）のエスケープ

ユーザースニペットを書くjsonファイルでは（$）記号はカーソル位置として認識されてしまいます。php変数に（$）が使用されますが、エスケープなしでは表示できなくなっています。

ダブルバックスラッシュ（\\）でエスケープできます。

つまり、for文を挿入するHTMLドキュメントに組み込むPHPのユーザースニペットのphp.jsonは以下のようになります。

{
	"php for":{
		"prefix": "<?php for(): ?>",
		"body":[
			"<?php for(\\$${1:i}=0; \\$${1:i} < ${2:1}; ++\\$${1:i}): ?>",
			"\t$0",
			"<? endfor; ?>"
		],
		"description": ""
	}
}