phpDocumentor 2のインストール手順(Mac/Win/Linux)

2013/01/03 追記:
Linux(Ubuntu)でも同様の手順でインストールが出来ました。伴って、一部、書き足しています。

--

公式:
http://www.phpdoc.org/

GitHub:
https://github.com/phpDocumentor/phpDocumentor2

以下、Mac(MAMP)とWin(XAMPP)とLinux(Ubuntu)で確認しています。コマンド形態(sudoとか)は、適宜置換して下さい。

$ pear update-channels
$ pear upgrade pear
$ pear upgrade-all
$ pear channel-discover pear.phpdoc.org
$ pear install -a phpdoc/phpDocumentor-alpha
$ phpdoc --version
phpDocumentor version 2.0.0a11

もしphpdoc/phpDocumentor-alphaのinstallで

Fatal error: Allowed memory size of 33554432 bytes exhausted (tried to allocate 587262 bytes) in /xxx/PEAR/Installer.php on line 580

のようなエラーが出たら

php -i | grep 'Configuration File'

で表示されるphp.iniのmemory_limitを

memory_limit = -1

にして、再度実行してみて下さい。(もとに戻すのを忘れずに。)

参考:
http://stackoverflow.com/questions/415801/allowed-memory-size-of-33554432-bytes-exhausted-tried-to-allocate-43148176-byte

基本的な使い方は

$ phpdoc -d [入力ディレクトリ] -t [出力ディレクトリ]

です。Twitter Bootstrapを採用しているのでキレイですね。

ヘルプの表示は

$ phpdoc -h

になります。

最低限必要な手順は、以上となります。
以下、補足です。

GraphVizというものがインストールされていないと

Unable to find the `dot` command of the GraphViz package. Is GraphViz correctly installed and present in your path?

と出ます。

GraphVizはMacとWinで、それぞれ、以下からDL可能です。

Mac:(mountainlion用は2012/12/01現在、graphviz-2.29.20121121.0545.pkgです。)
http://www.graphviz.org/Download_macos.php

Win:
http://www.graphviz.org/Download_windows.php

Ubuntuでは、以下のコマンドでインストールが可能です。

$ sudo apt-get install -y graphviz

GraphVizをインストールすることで、クラス継承図も出力してくれるようになります。

以下、Mac/Winそれぞれのトラブルシューティングメモです。
尚、環境によっては必要のない(無駄な)手順があるかもしれません。

Mac:
(1)
前述のGraphVizが見つからないエラーがどうにも消えませんでした。
試しにdotコマンドを実行してみると

$ dot
dyld: Library not loaded: /usr/lib/libltdl.7.dylib
  Referenced from: /usr/local/bin/dot
  Reason: image not found
Trace/BPT trap: 5

となり、libltdl.7.dylibというものが見つかっていない事が原因のようで

cp /opt/local/lib/libltdl.7.dylib /usr/lib/

したら解決しました。

実は最初、間違えてlion用のgraphviz-2.28.0.pkgを先にインストールしてしまったので、それが原因だったのかもしれません。

参考:
http://syrioyaji.homeunix.com:8000/wordpress/?p=263



Win:
(1)
phpdocを実行した時に

Could not open input file: \phpdoc.php

と出ました。
xxx\xampp\php\phpdoc.batの最終行を

"%PHPBIN%" "xxx\xampp\php\phpdoc.php" %*

に修正しました。

(2)
xxx\xampp\php\phpdoc.php を xxx\xampp\php\phpdoc としてコピーしました。

(3)
php.iniに

extension=php_xsl.dll

を追加しました。

(4)
PATHを通して再起動しました。



先にWinにインストールして、Winは無駄に手強いなーと思っていたら、Macの方がハマった。悔しい。。。