vim-php

An intuitive plugin to import/expand classes, traits and interfaces, finally!

2018-10-07: This repository still active, feel free to open issues or send pull request

Install

Install using your favorite plugin manager, like Vundle:

Plugin 'sahibalejandro/vim-php'

CTags

You need Universal Ctags to generate CTags for classes, traits and interfaces. Here you can find it: https://github.com/universal-ctags/ctags

Once you have installed Universal Ctags just run this command:

ctags --recurse --languages=php --php-kinds=ctif

You need at least the following kinds: cti, which corresponds to class, trait and interface.

Commands

PHPImportClass

This command will add the use Foo\Bar statement for the class/trait/interface under cursor.

PHPExpandFQCN

This command will expand the FQCN for the class/trait/interface under cursor.

PHPExpandFQCNAbsolute

This command will expand the FQCN with a leading backslash for the class/trait/interface under cursor.

Configuration

Just add this to your .vimrc file:

augroup VIM_PHP
    autocmd!
    autocmd FileType php nnoremap <Leader>u :PHPImportClass<cr>
    autocmd FileType php nnoremap <Leader>e :PHPExpandFQCNAbsolute<cr>
    autocmd FileType php nnoremap <Leader>E :PHPExpandFQCN<cr>
augroup END

Change the mappings to your needs.

Ordering use statements

By default when you import a class, all of the use statements will be sorted by length, if you want to sort them alphabetically set g:vim_php_use_sort to alpha in your .vimrc file:

let g:vim_php_use_sort='alpha'

Note that g:vim_php_use_sort='length' is the default. If you use any other value rather than length or alpha then the new use statements will be added after the last one, which means: no sorting.