felixfbecker/language-server

PHP Implementation of the Visual Studio Code Language Server Protocol

v5.4.6 2018-11-13 17:33 UTC

Requires

• php: ^7.0
• composer/xdebug-handler: ^1.0
• felixfbecker/advanced-json-rpc: ^3.0.0
• felixfbecker/language-server-protocol: ^1.0.1
• jetbrains/phpstorm-stubs: dev-master
• microsoft/tolerant-php-parser: 0.0.*
• netresearch/jsonmapper: ^1.0
• phpdocumentor/reflection-docblock: ^4.0.0
• psr/log: ^1.0
• sabre/event: ^5.0
• sabre/uri: ^2.0
• webmozart/glob: ^4.1
• webmozart/path-util: ^2.3

Requires (Dev)

• phpunit/phpunit: ^6.3
• squizlabs/php_codesniffer: ^3.1

ISC

• Felix Becker

• php
• code
• language
• server
• visual
• microsoft
• autocompletion
• refactor
• intellisense
• studio

README

A pure PHP implementation of the open Language Server Protocol. Provides static code analysis for PHP for any IDE.

Uses the great Tolerant PHP Parser, phpDocumentor's DocBlock reflection and an event loop for concurrency.

Table of Contents

• Features
• Performance
• Versioning
• Installation
• Running
• Used by
• Contributing

Features

Completion

Signature Help

Go To Definition

Find References

Hover

A hover request returns a declaration line (marked with language php) and the summary of the docblock. For Parameters, it will return the @param tag.

Document Symbols

Workspace Symbols

The query is matched case-insensitively against the fully qualified name of the symbol.
Non-Standard: An empty query will return all symbols found in the workspace.

Error reporting through Publish Diagnostics

PHP parse errors are reported as errors, parse errors of docblocks are reported as warnings. Errors/Warnings from the vendor directory are ignored.

Stubs for PHP built-ins

Completion, type resolval etc. will use the standard PHP library and common extensions.

What is considered a definition?

Globally searchable definitions are:

• classes
• interfaces
• traits
• properties
• methods
• class constants
• constants with const keyword

Definitions resolved just-in-time when needed:

• variable assignments
• parameters
• closure use statements

Not supported yet:

• constants with define()

Namespaces are not considerd a declaration by design because they only make up a part of the fully qualified name and don't map to one unique declaration.

What is considered a reference?

Definitions/references/hover currently work for

• class instantiations
• static method calls
• class constant access
• static property access
• parameter type hints
• return type hints
• method calls, if the variable was assigned to a new object in the same scope
• property access, if the variable was assigned to a new object in the same scope
• variables
• parameters
• imported closure variables (use)
• use statements for classes, constants and functions
• class-like after implements/extends
• function calls
• constant access
• instanceof checks
• Reassigned variables
• Nested access/calls on return values, properties, array access

Protocol Extensions

This language server implements the files protocol extension. If the client expresses support through ClientCapabilities.xfilesProvider and ClientCapabilities.xcontentProvider, the server will request files in the workspace and file contents through requests from the client and never access the file system directly. This allows the server to operate in an isolated environment like a container, on a remote workspace or any a different protocol than file://.

Performance

Upon initialization, the server will recursively scan the project directory for PHP files, parse them and add all definitions and references to an in-memory index. The time this takes depends on the project size. At the time of writing, this project contains 78 files + 1560 files in dependencies which take 97s to parse and consume 76 MB on a Surface Pro 3. The language server is fully operational while indexing and can respond to requests with the definitions already indexed. Follow-up requests will be almost instant because the index is kept in memory.

Having XDebug enabled heavily impacts performance and can even crash the server if the max_nesting_level setting is too low.

Versioning

This project follows semver for the protocol communication and command line parameters, e.g. a major version increase of the LSP will result in a major version increase of the PHP LS. New features like request implementations will result in a new minor version. Everything else will be a patch release. All classes are considered internal and are not subject to semver.

Installation

The recommended installation method is through Composer. Simply run

composer require felixfbecker/language-server

and you will get the latest stable release and all dependencies.
Running composer update will update the server to the latest non-breaking version.

After installing the language server and its dependencies, you must parse the stubs for standard PHP symbols and save the index for fast initialization.

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

Running

Start the language server with

php vendor/felixfbecker/language-server/bin/php-language-server.php

Command line arguments

--tcp=host:port (optional)

Causes the server to use a tcp connection for communicating with the language client instead of using STDIN/STDOUT. The server will try to connect to the specified address. Strongly recommended on Windows because of blocking STDIO.

Example:

php bin/php-language-server.php --tcp=127.0.0.1:12345

--tcp-server=host:port (optional)

Causes the server to use a tcp connection for communicating with the language client instead of using STDIN/STDOUT. The server will listen on the given address for a connection. If PCNTL is available, will fork a child process for every connection. If not, will only accept one connection and the connection cannot be reestablished once closed, spawn a new process instead.

Example:

php bin/php-language-server.php --tcp-server=127.0.0.1:12345

--memory-limit=integer (optional)

Sets memory limit for language server. Equivalent to memory-limit php.ini directive. The default is 4GB (which is way more than needed).

Example:

php bin/php-language-server.php --memory-limit=256M

Used by

• VS Code PHP IntelliSense
• Eclipse Che
• Eclipse IDE (LSP4E-PHP)
• NeoVim: LanguageServer-php-neovim with LanguageClient neovim
• Atom: ide-php

Contributing

You need at least PHP 7.0 and Composer installed. Clone the repository and run

composer install

to install dependencies.

Run the tests with

composer test

Lint with

composer lint

The project parses PHPStorm's PHP stubs to get support for PHP builtins. It re-parses them as needed after Composer processes, but after some code changes (such as ones involving the index or parsing) you may have to explicitly re-parse them:

composer run-script parse-stubs

To debug with xDebug ensure that you have this set as an environment variable

PHPLS_ALLOW_XDEBUG=1

This tells the Language Server to not restart without XDebug if it detects that XDebug is enabled (XDebug has a high performance impact).