Vimでref.vimを使ってPHPのリファレンスをただちに検索する

前回、前々回でRubyのリファレンスと、英辞郎 on the Webで英単語を検索する方法を書いたので、今回は自分がref.vimで使っている3つ目(最後)の検索ソース、PHPリファレンスの導入手順も備忘録。

PHPのref.vim実行結果

上記はref.vimで:Ref phpmanual htmlspecialcharsを実行した結果のキャプチャ画像。

ワイルドカードが使える

個人的にPHPは、今のところRubyほど書く頻度は多く無いので、関数がうろ覚えで「mb_・・・なんだっけ?」とか思い出せないことがよくあって、そんな時にref.vimはワイルドカードを使って:Ref phpmanual mb_*とできるのですごく重宝している。以下のキャプチャはその実行結果(の一部)で、mb_*な関数がズラーッとリストアップされている。ここから目的の関数名を選んでエンターを押せば、その関数のリファレンスが表示される。

PHPのref.vim実行結果

ブラウザーのアドレスバーにphp.net/mb_と入力してネットで検索しても似たようなことができるけど、ref.vimならVimで完結できることと、オフラインでも使えるのが大きなメリット。今回も前回前々回と同様に、下記のPHPリファレンス導入前にVim側ではref.vimが使用可能な状態になっていることが前提。

PHPリファレンスの導入(Mac/Windowsでほぼ共通)

  • PHPリファレンスを検索する場合もテキストブラウザーの導入が必要なので、英辞郎で英単語を検索する記事を参考にテキストブラウザーをインストールする
  • ここから「Japanese」の「Many HTML files」のtar.gzファイル(PHPリファレンスのHTML群を圧縮したもの)をダウンロードして解凍する
  • 適当な場所に配置する(例: D:\Documents\phpmanual
    • 配置するパスには、空白や日本語が含まれないのが(試してないけど)たぶん好ましい
  • .vimrcで、その配置した場所を指定する
let g:ref_phpmanual_path = 'D:\Documents\phpmanual'
  • Vimから適当にPHPの関数を検索:Ref phpmanual htmlspecialcharsしてみて、冒頭のキャプチャ画像のようなそれっぽいページが出てきたら設定完了!!

.vimrcでの設定

PHPリファレンスの場合は、上述のファイルへのパス以外は特に設定する項目は無いので、あとはショートカットの割り当てくらい。PHPリファレンスの場合、コマンド名(phpmanual)部分が長いのでショートカット割り当てはほぼ必須。

""" ref.vim
nmap ,rp :<C-u>Ref phpmanual<Space>
let g:ref_phpmanual_path = 'D:\Documents\phpmanual'

この設定の場合だと、ノーマルモードで,rp htmlspecialcharsまたは,rp htmlsp*として一覧から関数名を選択すれば、今までの例と同じようにPHPリファレンスでhtmlspecialcharsを検索できる。


Vimでref.vimを使ってRubyのリファレンスをただちに検索する Vimでref.vimを使って英辞郎で英単語をただちに検索する ref.vimを入れてみた - hamacoの日記 ref.vim を入れる - Heavens hell vimプラグインでよりよいコーディングを | tech.kayac.com - KAYAC engineers’ blog