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

PHPの無名関数+array系の関数

PHPの無名関数について。 PHP5.3.0以降で実装され、概念としては知っていましたが、あまり使ったことがありませんでした。 今開発しているPHPの案件で無名関数のソースをみたので、復習もかねてメモ …

no image

cakePHP3 serialize&compact

Contents1 serialize2 compact serialize cakePHP3の記述で

みたいな記述をよく見かけていま …

no image

phpの時分秒+cakePHPのupdate

ちょっと小ネタ集になります。 Contents1 PHPで秒→時分秒変換2 cakePHPでのupdate PHPで秒→時分秒変換 PHPで秒数から時分秒に変換するプログラムです。 汎用的かなと思った …

no image

APIに関して

RESTAPIのルーティングで気をつけることなんぞを。 直近のプロジェクトではRESTAPIを作ることが多かったんですが気をつけることなんぞを。 Contents1 仕様書はソースから2 ツール3 命 …

no image

Queueの登録と実際の処理に関して

実務でQueueに絡んだ処理をする機会があったのでメモ。 Contents1 Queueとは2 Laravelでのキュー処理2.1 キューを記録しておく場所2.2 処理を登録する場面(当然まだ処理は行 …