Sylvain Brunerie
e3297cdcae
The page about PHP in the docs doesn’t explain how to use Xdebug. I had a lof of trouble setting it up the first time, then recently had another headache trying to get it to work again, because the value for `adapter` had changed from `PHP` to `Xdebug`. It’s likely that my example config isn’t perfect or has redundant stuff or whatever, feel free to amend it. I also took the liberty to set the Phpactor and Intelephense headings to level 3 because I felt like they were part of "Choosing a language server." Release Notes: - N/A
95 lines
2.8 KiB
Markdown
95 lines
2.8 KiB
Markdown
# PHP
|
||
|
||
PHP support is available through the [PHP extension](https://github.com/zed-extensions/php).
|
||
|
||
- Tree-sitter: https://github.com/tree-sitter/tree-sitter-php
|
||
- Language Servers:
|
||
- [phpactor](https://github.com/phpactor/phpactor)
|
||
- [intelephense](https://github.com/bmewburn/vscode-intelephense/)
|
||
|
||
## Choosing a language server
|
||
|
||
The PHP extension offers both `phpactor` and `intelephense` language server support.
|
||
|
||
`phpactor` is enabled by default.
|
||
|
||
### Phpactor
|
||
|
||
The Zed PHP Extension can install `phpactor` automatically but requires `php` to be installed and available in your path:
|
||
|
||
```sh
|
||
# brew install php # macOS
|
||
# sudo apt-get install php # Debian/Ubuntu
|
||
# yum install php # CentOS/RHEL
|
||
# pacman -S php # Arch Linux
|
||
which php
|
||
```
|
||
|
||
### Intelephense
|
||
|
||
[Intelephense](https://intelephense.com/) is a [proprietary](https://github.com/bmewburn/vscode-intelephense/blob/master/LICENSE.txt#L29) language server for PHP operating under a freemium model. Certain features require purchase of a [premium license](https://intelephense.com/).
|
||
|
||
To switch to `intelephense`, add the following to your `settings.json`:
|
||
|
||
```json [settings]
|
||
{
|
||
"languages": {
|
||
"PHP": {
|
||
"language_servers": ["intelephense", "!phpactor", "..."]
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
To use the premium features, you can place your [licence.txt file](https://intelephense.com/faq.html) at `~/intelephense/licence.txt` inside your home directory. Alternatively, you can pass the licence key or a path to a file containing the licence key as an initialization option for the `intelephense` language server. To do this, add the following to your `settings.json`:
|
||
|
||
```json [settings]
|
||
{
|
||
"lsp": {
|
||
"intelephense": {
|
||
"initialization_options": {
|
||
"licenceKey": "/path/to/licence.txt"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
## PHPDoc
|
||
|
||
Zed supports syntax highlighting for PHPDoc comments.
|
||
|
||
- Tree-sitter: [claytonrcarter/tree-sitter-phpdoc](https://github.com/claytonrcarter/tree-sitter-phpdoc)
|
||
|
||
## Setting up Xdebug
|
||
|
||
Zed’s PHP extension provides a debug adapter for PHP and Xdebug. The adapter name is `Xdebug`. Here a couple ways you can use it:
|
||
|
||
```json
|
||
[
|
||
{
|
||
"label": "PHP: Listen to Xdebug",
|
||
"adapter": "Xdebug",
|
||
"request": "launch",
|
||
"initialize_args": {
|
||
"port": 9003
|
||
}
|
||
},
|
||
{
|
||
"label": "PHP: Debug this test",
|
||
"adapter": "Xdebug",
|
||
"request": "launch",
|
||
"program": "vendor/bin/phpunit",
|
||
"args": ["--filter", "$ZED_SYMBOL"]
|
||
}
|
||
]
|
||
```
|
||
|
||
In case you run into issues:
|
||
|
||
- ensure that you have Xdebug installed for the version of PHP you’re running
|
||
- ensure that Xdebug is configured to run in `debug` mode
|
||
- ensure that Xdebug is actually starting a debugging session
|
||
- check that the host and port matches between Xdebug and Zed
|
||
- look at the diagnostics log by using the `xdebug_info()` function in the page you’re trying to debug
|