PHPantom
PHP language support for Visual Studio Code powered by PHPantom, a fast language server with deep type intelligence, generics, and framework-awarness.
Features
- Code completion. Type-aware suggestions for symbols, keywords, and members with automatic use declaration insertion.
- Signature help. Parameter hints for constructors, methods, and functions.
- Navigation. Go to definition, type definition, implementation, find all references, and rename.
- Diagnostics. Undefined symbols, type errors, argument count mismatches, deprecated usage, unused imports, and implementation errors.
- Hover. Type information and PHPDoc documentation.
- Code actions. Extract variable/method/constant, inline variable, generate constructor/getters/setters, implement interface methods, auto-import, and PHPDoc generation.
- Call hierarchy and type hierarchy.
- Semantic tokens, inlay hints, and code lens.
- Document highlight and workspace symbol search.
- Formatting. PSR-12 compatible, with optional Laravel Pint integration.
- Code folding and smart selection.
- Document links for include/require paths.
- Deep type intelligence. Generics (
@template), PHPStan/Psalm annotations, and framework-aware analysis including Laravel Eloquent.
Quick Start
- Disable the built-in VS Code PHP Language Features.
- Go to
Extensions.
- Search for
@builtin php.
- Disable
PHP Language Features. Leave PHP Language Basics enabled for syntax highlighting.
- Disable other PHP language servers (Intelephense, Phpactor, PHP Tools) to avoid duplicate content.
- Open a PHP project. PHPantom downloads and starts the language server automatically.
To use a custom binary, set phpantom.serverPath to the path of your phpantom_lsp binary. You can build from source with cargo install phpantom_lsp or download a release from GitHub.
Settings
| Setting |
Default |
Description |
phpantom.serverPath |
"" |
Path to a custom phpantom_lsp binary. |
phpantom.releaseTag |
"latest" |
GitHub release tag to download. |
phpantom.autoDownload |
true |
Automatically download the server if not found. |
phpantom.autoUpdate |
true |
Check for newer releases periodically. |
phpantom.updateCheckIntervalHours |
24 |
How often to check for updates (1-168 hours). |
phpantom.trace.server |
"off" |
Trace communication with the language server. |
Commands
- PHPantom: Restart Language Server. Restart the language server.
- PHPantom: Show Output. Open the PHPantom output channel.
- PHPantom: Show Server Version. Display the running server version.
- PHPantom: Check for Server Update. Check for a newer server binary.
- PHPantom: Clear Downloaded Language Server. Remove cached server binaries.
How It Works
On activation the extension locates a server binary in this order:
phpantom.serverPath settingphpantom_lsp on PATH- A previously cached binary
- Download from GitHub Releases (when
phpantom.autoDownload is enabled)
When phpantom.releaseTag is "latest", the extension checks for updates on startup and periodically while active. A status bar item shows the server state.
Troubleshooting
If the download fails, open the PHPantom output channel for details. You can always download a binary manually and set phpantom.serverPath.
If your platform is unsupported, build from source and point phpantom.serverPath at the result.
License
MIT
See the PHPantom language server changelog for improvements to type intelligence, diagnostics, and completions.
| |
