PHP layer

This is the recommended LSP server solution. To activate it set the layer variable php-backend:

(php :variables php-backend 'lsp)

and install the npm server with:

npm install -g intelephense

You can find further information on the project's website and GitHub page.

This is an alternative LSP server implementation working on PHP basis rather than nodejs. To activate it set the layer variable php-backend like for the intelephense backend and install the server via composer:

composer require felixfbecker/language-server
composer run-script --working-dir=vendor/felixfbecker/language-server parse-stubs

You can find further information on the project's GitHub page.

In case of using any of LSP backends You can debug using dap.

First of all You have to add dap to layer list of Your dotspacemacs/layers function of a .spacemacs config file.

As mentioned in dap-mode doc for php, dap-mode uses a VSCode extension as a debugging backend and includes a convenient dap-php-setup command to install it into Your emacs. To embrace it open any PHP file in any PHP project just after restarting emacs with dap layer enabled. Now You can call the extension installation command: <M-x> dap-php-setup.

After that You can try to debug something. For example add a breakpoint to any of Your phpunit tests with SPC m d b a. And start debugging with SPC m d d d and selecting a debug template. Now run the test to ensure everything is working. You may refer to one of the following examples to run Your tests.

For xdebug v2:

php -d xdebug.idekey=PHPSTORM -d xdebug.remote_autostart=1 -d xdebug.remote_enable=1 -d xdebug.remote_host=127.0.0.1 -d xdebug.remote_port=9000 bin/phpunit ./path/to/Test.php

For xdebug v3:

php -d xdebug.idekey=PHPSTORM -d xdebug.start_with_request=yes -d xdebug.mode=debug -d xdebug.client_host=127.0.0.1 -d xdebug.client_port=9000 bin/phpunit ./path/to/Test.php

Make sure You use the proper host. For example both localhost and 127.0.0.1 most likely will not work while debugging inside of docker. You have to use either host.docker.internal or Your machine's external IP if it doesn't work. See this docker issue for reasons of troubles with host.docker.internal.

The test is now expected to be paused by emacs/dap when it catches code at the breakpoint.

You may wish to propagate some config options for the VSCode extension which is used as a debug server. For example if You are running Your code in a docker container the project source path may differ between the container (and Xdebug PHP extension consequently) and Emacs. The VSCode extension provides a config option to map the path. In VSCode it is done by adding an appropriate json config. For spacemacs it could be done for example by adding a next call to dotspacemacs/user-config function of Your .spacemacs config:

(with-eval-after-load 'dap-php
  (dap-register-debug-template "PHP debug with custom path"
    (list :type "php"
          :cwd nil
          :request "launch"
          :name "Php Debug with path"
          :args '("--server=4711")
          :pathMappings (ht ("/docker/src/path" "/emacs/src/path"))
          :sourceMaps t)))

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

   cd /root/of/project
   touch .ac-php-conf.json
   

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.

This backend provides refactoring and class auto-completion capabilities via phpactor.el. To ensure that the phpactor package is intact, just run M-x phpactor-install-or-update and the package itself will make sure that you're good to go.

While using ac-php-core debug capabilities are provided via the geben package. Please refer for details to the project page.