skillup

技術ブログ

PHP

phpmdによるコードチェック

投稿日:2017年4月23日 更新日:

現在のプロジェクトですが、コードレビューなどをされる環境にはないため、一人で書いていると自然と規約とずれた書き方になっていることもあります。

規約通りに書こう、書こうと思っていてもなかなかその通りに書くことは大変です。そんな時はコードレビューを自動でチェックしてくれるツールなどを使うのが便利です。phpにはphpmdというツールがあり実装上の問題点などを検出してくれるツールです。

インストール

以前はpearなどでインストールもできていましたが、現在ではcomposerを使ってinstallをすることが一般的でしょう。

下記のようにcomposer.jsonにかいてアップロードすることが一般的です。

composerに書いて、installすればvendorの下には入ります。ただpathをとおすために下記のようにシンボリックリンクを張ると便利です。

使い方

あとは実際のコードのチェックを行います。

コマンドの意味ですが、

phpmd チェックしたいPHPファイルパス [レポートフォーマット(text or xml or html)] [チェック項目 カンマ区切りで複数可能]

具体的なチェック項目ですが、下記のような意味です。

  • cleancode: elseを使わず、staticアクセスしないなどを検知するツール
  • codesize:循環的複雑度などコードサイズ関連部分を検出するルール
  • controversial:キャメルケースなど議論の余地のある部分を検出するルール
  • design:ソフトの設計関連の問題を検出するルール
  • naming:長すぎたり、短すぎたりする名前を検出するルール
  • unusedcode:使われていないコードを検出するルール

上記では全て入れていますが・・・コマンドを実行すると下記のようなメッセージが出力されます。

参考リンク

phpmdについて

PHPの静的コード解析ツール『PHPMD』を使ってみた。

phpmd公式

https://phpmd.org/

シンボリックリンクについて

lnコマンドについて詳しくまとめました 【Linuxコマンド集】

-PHP
-

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

herokuでのmb_convert_encoding

herokuにあげたアプリを起動しようとしたらmb_convert_encodingでundefinedエラーが帰ってきました。 どうやらマルチバイトのライブラリがないエラーのようですね。 といいつつ …

no image

PHPでのログ出力 PHP monolog

PHPでデバッグするときは、画面上にvar_dumpで情報を見ていたのですが、これができない場面ではログへの出力を行うことになります。 いままではフレームワークに標準でついてたんですが、これを機に一般 …

no image

phpのライブラリ(mcrypt)インストール

先日、ローカルで開発していたPHPをサーバーにアップして、composerでライブラリをアップデートしようとしたところ、 "The mcrypt extension is missing. Please check your PHP configuration." なるエラー …

no image

cakePHPでのマイグレーション

開発を続けているとデータベースのカラムの構造が変更するってことはしょっちゅうですが、管理がいい加減だとメンバー間でテーブルの構造が変わっていたり、本番と開発で違ってくるなどのトラブルが続出します。 そ …

no image

phpenv+php-build 複数のPHPのversionを使い分け

使っているサーバーで別バージョンのphp(7.2.0)を使いたかったのでphpenv&php-buildをインストール。 Contents1 phpenvのインストール2 php instal …