103 lines
3.1 KiB
Org Mode
103 lines
3.1 KiB
Org Mode
#+TITLE: PHP layer
|
|
|
|
#+TAGS: general|layer|multi-paradigm|programming
|
|
|
|
[[file:img/php.png]]
|
|
|
|
* Table of Contents :TOC_5_gh:noexport:
|
|
- [[#description][Description]]
|
|
- [[#features][Features:]]
|
|
- [[#install][Install]]
|
|
- [[#layer][Layer]]
|
|
- [[#setting-the-backend][Setting the backend]]
|
|
- [[#backend][Backend]]
|
|
- [[#language-server-protocol][Language Server Protocol]]
|
|
- [[#intelephense][intelephense]]
|
|
- [[#php-language-server][php-language-server]]
|
|
- [[#key-bindings][Key bindings]]
|
|
- [[#usage][Usage]]
|
|
|
|
* Description
|
|
This layer adds PHP language support to Spacemacs.
|
|
|
|
** Features:
|
|
- Edit PHP files using [[https://github.com/ejmr/php-mode][php-mode]]
|
|
- Edit Drupal files
|
|
- Complete and jump to define with [[https://github.com/xcwen/ac-php][company-php]]
|
|
- Run tests with PHPUnit
|
|
- Reformat code with PHP CBF
|
|
- Support for the [[https://langserver.org/][Language Server Protocol]] (experimental)
|
|
|
|
The =gtags= layer is recommended to benefit from better =eldoc= and
|
|
=helm-gtags=.
|
|
|
|
* Install
|
|
** Layer
|
|
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
|
|
add =php= to the existing =dotspacemacs-configuration-layers= list in this
|
|
file.
|
|
|
|
** Setting the backend
|
|
To activate the backend set the layer variable =php-backend=:
|
|
|
|
#+BEGIN_SRC elisp
|
|
(php :variables php-backend 'lsp)
|
|
#+END_SRC
|
|
|
|
For spacemacs to use lsp you also need to add =lsp= to the
|
|
=dotspacemacs-configuration-layers= in your =~/.spacemacs= file.
|
|
|
|
* Backend
|
|
** Language Server Protocol
|
|
=lsp-mode= currently supports two lsp backends for php. When both are installed,
|
|
the former takes priority over the latter:
|
|
|
|
*** intelephense
|
|
|
|
#+BEGIN_SRC sh
|
|
nmp install -g intelephense
|
|
#+END_SRC
|
|
|
|
You can find further information on the project's [[http://intelephense.net/][website]] and [[https://github.com/bmewburn/vscode-intelephense][GitHub page]].
|
|
|
|
*** php-language-server
|
|
|
|
#+BEGIN_SRC sh
|
|
composer require felixfbecker/language-server
|
|
composer run-script --working-dir=vendor/felixfbecker/language-server parse-stubs
|
|
#+END_SRC
|
|
|
|
You can find further information on the project's [[https://github.com/felixfbecker/php-language-server%20][GitHub page]].
|
|
|
|
* Key bindings
|
|
|
|
| Key binding | Description |
|
|
|-------------+-------------------------|
|
|
| ~SPC m g g~ | jump to define at point |
|
|
| ~C-t~ | jump back |
|
|
|
|
* Usage
|
|
Because of the way that the ac-php-core package works, there are a couple of simple
|
|
initialization tasks which must occur to get the completion working as it should.
|
|
On any new project make sure to perform the following initialization tasks:
|
|
1. Run the following
|
|
|
|
#+BEGIN_SRC shell
|
|
cd /root/of/project
|
|
touch .ac-php-conf.json
|
|
#+END_SRC
|
|
|
|
2. Inside of spacemacs run: = ac-php-remake-tags =
|
|
|
|
The =.ac-php-conf.json= file is required to enable auto-completion. When you run
|
|
=ac-php-remake-tags= and your =.ac-php-conf.json= file is empty the default configuration
|
|
will be used and inserted in the file.
|
|
|
|
If your project contains the following files at the root folder:
|
|
1. =.projectile=
|
|
2. =vendor/autoload.php=
|
|
|
|
the necessary configuration file (=.ac-php-conf.json=) will be created automatically
|
|
if it does not exist.
|