Unix or VIM command to format PHP code - php

I know that you can use the indent command to beautify c code. I want to do the same thing with php but the command is giving errors (it is intended for c only I believe) is there a standard way to formatt php code with a command? I would be open to either a unix command that comes with OS X or a VIM command.

If vim has been set up to recognize PHP, type =G at the top of your file and it will reindent your code to the end.
To expand on rkulla's comment, = is the indentation command, while G is the command to go to the end of the document and gg goes to the beginning. If you want to indent the next 5 lines beginning from your current line, you can type =5= or 5==.

If you are using VIM, erjiang's answer is the best method. For reference for yourself or anyone reading this who does not use VIM, there is a PEAR module for beautifying PHP called 'PHP Beautifier'.
http://beautifyphp.sourceforge.net
See command line usage in the documentation.

Related

how to run PHP scripts live in Vim [duplicate]

Is it possibly to run a PHP file from within vim? What im trying to do here is having a shortcut so whenever I need to run the file I'm editing to skip exiting vim and calling the PHP interpreter manually
Yes! It's possible to do what you want. Both running PHP from within vim, and creating a shortcut.
Matthew Weier O'Phinney writes:
Probably the most useful thing I've
done as a PHP developer is to add
mappings to run the current file
through (a) the PHP interpreter (using
Ctrl-M), and (b) the PHP interpreter's
linter (using Ctrl-L).
Vim Productivity Tips for PHP Developers
Example:
:autocmd FileType php noremap <C-M> :w!<CR>:!/usr/bin/php %<CR>
Or (this doesn't check the filetype beware)
:map <C-M> :w!<CR>:!/usr/bin/php %<CR>
Joe 'Zonker' Brockmeier writes:
Vim also allows you to execute a
command directly from the editor,
without needing to drop to a shell, by
using bang (!) followed by the command
to be run. For instance, if you're
editing a file in Vim and want to find
out how many words are in the file,
run
:! wc %
Vim tips: Working with external commands
You can use:
:!php %
% stands for the current document, and :! executes any shell command.
You can also create a shortcut for it.
I have this in my .vimrc
" set make command when editing php files
set makeprg=php\ -l\ %
set errorformat=%m\ in\ %f\ on\ line\ %l
and then I map to F7 (or whatever you want) with:
:map <F7> :make <CR>

Validate PHP syntax in VIM

I would like to know how if it's possible to validate if a PHP file is valid in VIM without closing VIM every time?
Thank you
You can execute shell commands in vim. This is the same as calling php -l filename.php from the shell:
:!php -l %
I have this mapped into my ~/.vim/after/ftplugin/php.vim file so that I only have to press F5:
map <F5> :!php -l %<CR>
Use :make with the following php specific settings:
:set makeprg=php\ -l\ %
:set errorformat=%m\ in\ %f\ on\ line\ %l,%-GErrors\ parsing\ %f,%-G
Your syntax errors will be in the Quickfix window. You can open this buffer with :copen or :cope for short. If you only want to open the window only if their are errors use :cwindow.
You can use :cnext and :cprev to move through the quickfix list to jump to the corresponding errors. I suggest Tim Pope's excellent unimpared.vim plugin to make moving through the list as simple as [q and ]q.
To simplify the workflow I suggest a mapping like this one:
nnoremap <f5> :update<bar>make<bar>cwindow<cr>
Now you can just hit <f5> and the buffer will be updated (if necessary), linted, and any errors will appear in the quickfix window.
To make this a bit more robust, add these commands to ~/.vim/after/ftplugin/php.vim. Example ~/.vim/after/ftplugin/php.vim
setlocal makeprg=php\ -l\ %
setlocal errorformat=%m\ in\ %f\ on\ line\ %l,%-GErrors\ parsing\ %f,%-G
nnoremap <buffer> <silent> <f5> :update<bar>sil! make<bar>cwindow<cr>
For more information:
:h quickfix
:h makeprg
:h errorformat
:w !php -l
The real credit goes to Can I see changes before I save my file in Vim? for the idea so up vote there.
But to explain on this post (mostly taken from above):
The above command works as follows:
The syntax for saving a file in vim is:
:w <filename>
The syntax for executing a shell command in vim is:
:!<command>
Executing the save command without a filename but rather a shell command behind it causes vim to write the files content to stdin of the shell instead of saving it in a physical file. You can verify this by executing
:w !cat
This should always print the files current content (which would have been written to a file instead).
4 You can check code with php -l from STDIN by piping it in
The file is "saved" to stdin, php lint is run with the stdin as input.
To check PHP syntax without having to save first you can use:
map :w !php -l
http://vim.wikia.com/wiki/Runtime_syntax_check_for_php
You should try a plugin like Neomake. It will show you in the gutter error markers for every PHP syntax errors. Go on the line to see the error itself. You can as well link it to PHP Mess detector and PHP Stan to show you errors and possible improvements in your code.
This combo is very powerful!
In case you are interested I wrote an article how to make a Vim PHP IDE. This is basically a list of essential plugins you should try out! Of course Neomake is part of it.
For just syntax highlight (what sometimes gives clues about errors) a non yet saved file (usually black and white on vim) just source the syntax file:
:source $VIMRUNTIME/syntax/[the syntaxfile].vim
Examples
:source $VIMRUNTIME/syntax/sh.vim
:source $VIMRUNTIME/syntax/php.vim
:source $VIMRUNTIME/syntax/javascript.vim
You can manually run the PHP linting commands, but if you're doing full time development in PHP then it's easier to use a generic syntax checking plugin.
Syntastic (as recommended by #lucapette) has long been the main syntax plugin for Vim with fairly relaxed requirements:
Syntastic itself has rather relaxed requirements: it doesn't have any external dependencies, and it needs a version of Vim compiled with a few common features: autocmd, eval, file_in_path, modify_fname, quickfix, reltime, statusline, and user_commands. Not all possible combinations of features that include the ones above make equal sense on all operating systems, but Vim version 7 or later with the "normal", "big", or "huge" feature sets should be fine.
Since Vim 8, which allows for asynchronous syntax checking, there are now two good plugins. These work by continuously linting your code so you don't have to save your code for errors to show up:
Asyncronous Lint Engine (ale)
Neomake (as recommended by #matthieu)
All of these should automatically call php -l for the current file as long as the syntax for that file is set to PHP (:set syntax=php if Vim doesn't automatically recognise the syntax).

Run PHP file from within vim

Is it possibly to run a PHP file from within vim? What im trying to do here is having a shortcut so whenever I need to run the file I'm editing to skip exiting vim and calling the PHP interpreter manually
Yes! It's possible to do what you want. Both running PHP from within vim, and creating a shortcut.
Matthew Weier O'Phinney writes:
Probably the most useful thing I've
done as a PHP developer is to add
mappings to run the current file
through (a) the PHP interpreter (using
Ctrl-M), and (b) the PHP interpreter's
linter (using Ctrl-L).
Vim Productivity Tips for PHP Developers
Example:
:autocmd FileType php noremap <C-M> :w!<CR>:!/usr/bin/php %<CR>
Or (this doesn't check the filetype beware)
:map <C-M> :w!<CR>:!/usr/bin/php %<CR>
Joe 'Zonker' Brockmeier writes:
Vim also allows you to execute a
command directly from the editor,
without needing to drop to a shell, by
using bang (!) followed by the command
to be run. For instance, if you're
editing a file in Vim and want to find
out how many words are in the file,
run
:! wc %
Vim tips: Working with external commands
You can use:
:!php %
% stands for the current document, and :! executes any shell command.
You can also create a shortcut for it.
I have this in my .vimrc
" set make command when editing php files
set makeprg=php\ -l\ %
set errorformat=%m\ in\ %f\ on\ line\ %l
and then I map to F7 (or whatever you want) with:
:map <F7> :make <CR>

Shebang #! unrecognized in Ubuntu, File created in Windows7 | Troubleshoot encoding

Basically, the file was broken some where along the way from Windows7 to Ubuntu.
How can I look at a binary representation of the file to see what happened?
PHP command line script still have to have the <?php opener in them.
#!/usr/bin/php
echo "hi mom!\n";
will not work, it has to be
#!/usr/bin/php
<?php
echo "hi mom!\n";
This is because there's no such thing as a "php script". There are only various text files that have PHP code blocks embedded within them. Even in CLI mode, PHP expects/requires to see at least one <?php block. Otherwise the interpreter won't kick in and won't see any of the code, even though you've stated it's a PHP script with the shebang.
PHP cli mode is basically a hacked-in afterthought. PHP started out as a server-side CGI script parser and has not fundamentally changed from that mode.
Did you run with a ./?
IE:
./myscript.php
Try opening it with vi(m) and you'll see the problem. It's a bad intepreter (^M) at the end of each line. Try converting it (fromdos or dos2unix), this shoul'd fix the problem ;-)
My guess is that the files created on Windows have a BOM that is confusing matters.
When using Notepad++ on a Windows machine, one can change the EOL character from Windows to UNIX by going to
Edit > EOL Conversion > UNIX format
Double-check Notepad++'s status bar at the bottom-right to confirm your selection.
After saving and running from the command line, you should find that the PHP interpreter directive is now properly recognized.

Vim: undefined variables are unmarked

Lately I've been making a couple of mistakes when refactoring in Vim, the result was undefined and unused variables. Any decent IDE (like NetBeans) would mark them as such, but I've yet to come across a Vim plugin that does the same.
Can anyone help me out? I'm mainly programming in PHP.
There should be a solution with the Syntastic plugin, on which you would need to put a PHP static code analyzer like PHPLint.
However I never spent some time to test this !
Other PHP programs can be found on this SO answer.
You can run Zend's PHP code analyzer from within VIM. I currently do this. The catch is that Zend Code Analyzer is no longer packaged as a separate binary when installing Zend Studio. I'm not sure which OS you are running. I'm running on OS X. If you don't already have the binary, use steps 1 & 2 on this site to get it - http://michalf.me/blog:zend-code-analyzer-in-textmate. You may have to adjust for your OS.
After getting the binary add the following to your .vimrc and replace the /usr/local/... with the path to your ZendCodeAnalyzer.
if !exists("autocommands_loaded")
let autocommands_loaded = 1
"PHP Make
autocmd BufRead *.inc,*.php set makeprg=/usr/local/bin/ZendCodeAnalyzer\ %
autocmd BufRead *.inc,*.php set errorformat=%f(line\ %l):\ %m
endif
map <F7> :silent lmake<cr>:lwindow <cr>:redraw!<cr>
Now when you enter F7 it will run make which is set to run the ZendCodeAnalyzer. It will put the results into a location list - :help location. You can scroll through the location list and hit enter on a line and it will take you to that line in your file. If it doesn't find anything, then it won't open anything.
Well, this might not be what you are looking for, but if you must have Vim keybindings (I know I need them), then jVi brings this to NetBeans. I don't know if this is a viable option for you, but maybe this will help.
When renaming vars in a whole file type in vi cmd line:
:%s/\$oldName/\$newName/
When renaming the between line 14 and 21 (e.g inside a function) type
:14,21s/\$oldName/\$newName/
When renaming vars recursively in a directory type in vi cmd line:
:!find DIRECTORY_PATH -name "*.php" | xargs sed -ni 's/\$oldName/\$newName/'
Make a backup of the folder before to avoid headaches. ;)
I'm not sure how intelligent this plugin is but it seems to do what you want: https://github.com/vim-scripts/php_localvarcheck.vim

Categories