コンテンツにスキップ

Top

phUML で php のクラス図一覧を生成する

Doxygen で php のクラス図を作ろうとしたところ、単独で存在しているクラスに関してクラス図が生成できませんでした。
他のクラスから継承されているとか、インスタンスを生成されていたりしないとクラス図が生成されないようです。

phpの場合、Laravelなどのフレームワークから呼び出されるクラスもあり、ソースだけ見たらどこからも呼び出されていないように見える単独のクラスも出てくるのでそれでは困ります。
ので、クラス図の一覧をシンプルに出してくれるツールを探していたところ、phUMLがありましたので、これの使い方について述べます。

phUML のインストール

install は composerで行います。

$ composer global require phuml/phuml

クラス図のPDFの作成

以下のようにコマンドプロンプトで実行すると、PDFが出力されます。

$ phuml phuml:dot -r -a -i -o  <phpのソースコードがあるディレクトリパス> class_diagram.gv
$ neato -Tpdf class_diagram.gv > class_diagram.pdf
$ rm class_diagram.gv

以上です。