2015-12-02 14:23:39 +00:00
#+TITLE : PHP layer
2016-04-13 03:31:38 +00:00
2019-05-07 08:53:56 +00:00
#+TAGS : general|layer|multi-paradigm|programming
2019-05-05 17:26:40 +00:00
2015-06-10 16:44:30 +00:00
[[file:img/php.png ]]
2019-05-07 20:05:06 +00:00
* Table of Contents :TOC_5_gh:noexport:
2017-05-22 14:16:12 +00:00
- [[#description ][Description ]]
- [[#features ][Features: ]]
- [[#install ][Install ]]
2019-01-02 21:34:56 +00:00
- [[#layer ][Layer ]]
- [[#setting-the-backend ][Setting the backend ]]
- [[#backend ][Backend ]]
- [[#language-server-protocol ][Language Server Protocol ]]
- [[#intelephense ][intelephense ]]
- [[#php-language-server ][php-language-server ]]
2017-05-22 14:16:12 +00:00
- [[#key-bindings ][Key bindings ]]
2019-04-08 16:59:32 +00:00
- [[#usage ][Usage ]]
2015-06-10 16:44:30 +00:00
* Description
This layer adds PHP language support to Spacemacs.
2015-06-10 21:16:01 +00:00
** Features:
2015-06-10 16:44:30 +00:00
- Edit PHP files using [[https://github.com/ejmr/php-mode ][php-mode ]]
- Edit Drupal files
2017-05-24 05:18:41 +00:00
- Complete and jump to define with [[https://github.com/xcwen/ac-php ][company-php ]]
2015-06-10 16:44:30 +00:00
- Run tests with PHPUnit
- Reformat code with PHP CBF
2019-01-02 21:34:56 +00:00
- Support for the [[https://langserver.org/ ][Language Server Protocol ]] (experimental)
2015-06-10 16:44:30 +00:00
The =gtags= layer is recommended to benefit from better =eldoc= and
=helm-gtags= .
* Install
2019-01-02 21:34:56 +00:00
** Layer
2016-01-06 05:21:55 +00:00
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.
2015-06-10 16:44:30 +00:00
2019-01-02 21:34:56 +00:00
** 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 ]].
2015-06-10 16:44:30 +00:00
* Key bindings
2018-12-05 03:03:03 +00:00
| Key binding | Description |
2017-05-24 05:18:41 +00:00
|-------------+-------------------------|
| ~SPC m g g~ | jump to define at point |
| ~C-t~ | jump back |
2017-11-18 22:34:08 +00:00
2019-04-08 16:59:32 +00:00
* Usage
Because of the way that the ac-php-core package works, there are a couple of simple
2017-11-18 22:34:08 +00:00
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
2018-09-19 03:54:47 +00:00
2018-10-17 04:03:28 +00:00
#+BEGIN_SRC shell
cd /root/of/project
touch .ac-php-conf.json
#+END_SRC
2018-09-19 03:54:47 +00:00
2017-11-18 22:34:08 +00:00
2. Inside of spacemacs run:
2019-04-08 16:59:32 +00:00
= 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.