PHPのコーディングルール

PHPのコーディングルール

PHPのコーディングルールを確認する

PHPをプログラミング（コーディング）する際には、推奨ルールがあります。基本コーディング標準（PSR-1 Basic Coding Standard）と拡張コーディングスタイル（PSR-12 Extended Coding Style）があり、それぞれ公式ドキュメント（PSR-1、PSR-12）があります。日本語版は、こちら（PSR-1、PSR-12）。

VSCode（過去記事）でコーディングルールを自動補正

コーディングルールを一通り確認しても（しなくても）VSCodeを使ってある程度は自動補正することができます。ソフトは、php-cs-fixer を使います。Macで個人開発をする場合は、HomeBrewをインストール済みであれば、以下のコマンドを使ってインストールできます。

brew upgrade php-cs-fixer

VSCodeにおける設定は、F1キーで検索窓へ行き、

基本設定：設定（JSON）を開く
Preferences: Open Setting (JSON) 

を選択します。タブに表示された settings.json のファイルの中身に以下のコメントを追加します。下記の1行目のPathは、バージョンが3.9.5の場合です。インストール時点でのバージョンによってPathが異なるため、その都度、バージョンをご確認ください。

"php-cs-fixer.executablePath": "/opt/homebrew/Cellar/php-cs-fixer/3.9.5/bin/php-cs-fixer", // PHP-CS-Fixer.pharの配置パス
"php-cs-fixer.formatHtml": true, // フォーマッター実行時にHMTLも整形する
"php-cs-fixer.onsave": true, // 保存時に整形を実行する

それでは、PHPコードの自動補正を実行します。元のルールを破ったコードは、以下の通り。

<?php
$hogehoge = 1;
if ($hogehoge <= 1) {echo '$hogehogeは1以下です。' . PHP_EOL;
echo 'var_dumpは' . PHP_EOL;var_dump($hogehoge <= 1);echo 
'を返します。' 
. PHP_EOL;} 
else {echo '$hogehogeは1以上' . PHP_EOL;}

このファイルに対して、VSCodeで F1キー を押して、以下の php-cs-fixer: fix this file を入力します。なお、JSONファイルで設定した通り、普通に保存するだけでも自動補正されます。

php-cs-fixer: fix this file

実行結果。

<?php

$hogehoge = 1;

if ($hogehoge <= 1) {
    echo '$hogehogeは1以下です。' . PHP_EOL;
    echo 'var_dumpは' . PHP_EOL;
    var_dump($hogehoge <= 1);
    echo 'を返します。' . PHP_EOL;
} else {
    echo '$hogehogeは1以上' . PHP_EOL;
}

ほんと便利です。