CODEWITHSUNDEEP
phpvimidectags
dotancohen
dotancohen

Reputation: 31481

VIM: Show PHP function / class in command line?

Is there any way to show the current PHP function or class name in the VIM command line? I found a plugin for showing C function names in the status line but it does not work for PHP and in any case I prefer the command line be used to save valuable vertical lines.

Thanks.

Upvotes: 4

Views: 1108

Answers (2)

Prince Goulash
Prince Goulash

Reputation: 15715

I don't know anything about PHP, and I'm not trying to step on anyone's toes, but having looked at some PHP code I came up with this function which I think takes a simpler approach than the plugins that have been mentioned.

My assumpmtion is that PHP functions are declared using the syntax function MyFunction(){} and classes declared using class MyClass{} (possibly preceded by public). The following function searches backwards from the cursor position to find the most recently declared class or function (and sets startline). Then we search forward for the first {, and find the matching }, setting endline. If the starting cursor line is inbetween startline and endline, we return the startline text. Otherwise we return an empty string.

function! PHP_Cursor_Position()
    let pos = getpos(".")
    let curline = pos[1]
    let win = winsaveview()
    let decl = ""
    let startline = search('^\s*\(public\)\=\s*\(function\|class\)\s*\w\+','cbW')
    call search('{','cW')
    sil exe "normal %"
    let endline = line(".")
    if curline >= startline && curline <= endline
        let decl = getline(startline)
    endif
    call cursor(pos)
    call winrestview(win)
    return decl
endfunction

set statusline=%{PHP_Cursor_Position()}

Because it returns nothing when it is outside a function/class, it does not display erroneous code on the statusline, as the suggested plugin does.

Of course, I may well be oversimplifying the problem, in which case ignore me, but this seems like a sensible approach.

Upvotes: 2

romainl
romainl

Reputation: 196606

EDIT

While looking for something completely unrelated in TagList's help I've just found these two functions:

Tlist_Get_Tagname_By_Line()
Tlist_Get_Tag_Prototype_By_Line()

Adding this in my statusbar works beautifully:

%{Tlist_Get_Tagname_By_Line()}

Also, did you read the Vim Wiki? It has a bunch of tips trying to adress the same need. There is also this (untested) plugin.

ENDEDIT

If you are short on vertical space maybe you won't mind using a bit of horizontal space?

TagList and TagBar both show a vertical list of the tags used in the current buffer (and other opened documents in TagList's case) that you can use to navigate your code.

However, I'm not particularly a fan of having all sorts of informations (list of files, VCS status, list of tags, list of buffers/tabs…) displayed at all times: being able to read the name of the function you are in is only useful when you actually need to know it, otherwise it's clutter. Vim's own [{ followed by <C-o> are enough for me.

Upvotes: 3

Related Questions