vscode-php-intellisense/README.md

# PHP IntelliSense

[![vs marketplace](https://img.shields.io/vscode-marketplace/v/felixfbecker.php-intellisense.svg?label=vs%20marketplace)](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [![downloads](https://img.shields.io/vscode-marketplace/d/felixfbecker.php-intellisense.svg)](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [![rating](https://img.shields.io/vscode-marketplace/r/felixfbecker.php-intellisense.svg)](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [![build](https://travis-ci.org/felixfbecker/vscode-php-intellisense.svg?branch=master)](https://travis-ci.org/felixfbecker/vscode-php-intellisense) [![php: >=7.0.0](https://img.shields.io/badge/php->=7.0-8892BF.svg)](https://php.net/) [![chat: on gitter](https://badges.gitter.im/felixfbecker/vscode-php-intellisense.svg)](https://gitter.im/felixfbecker/vscode-php-intellisense?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Advanced PHP IntelliSense for Visual Studio Code.

**Note: This is just the VS Code extension that spawns the actual language server. The language server itself is implemented purely in PHP [in its own repository](https://github.com/felixfbecker/php-language-server), all features need to be implemented there and all issues should be reported there. You do NOT need to install it manually though, it is bundled in this extension.**

## Installation

You need at least PHP 7 installed for the extension to work. You can either add it to your PATH or set the `php.executablePath` setting.

I recommend to disable VS Code's built-in PHP IntelliSense by setting `php.suggest.basic` to `false` to avoid duplicate suggestions.

## Features

### Completion

![Completion search demo](images/completion.gif)

### Signature Help

![Signature help demo](images/signatureHelp.gif)

### Workspace symbol search

![Workspace symbol search demo](images/workspaceSymbol.gif)

### Find all References

![Find References demo](images/references.png)

### Go to Definition

![Go To Definition demo](images/definition.gif)

### Hover

![Hover class demo](images/hoverClass.png)

![Hover parameter demo](images/hoverParam.png)

### Find all symbols

![Find all symbols demo](images/documentSymbol.gif)

### Column-accurate error reporting

![Error reporting demo](images/publishDiagnostics.png)

### Code style linting

Please use a dedicated extension like [PHP CodeSniffer](https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs).

### Format code

Please use a dedicated extension like [PHP CS Fixer](https://marketplace.visualstudio.com/items?itemName=junstyle.php-cs-fixer).

## Todo

- Rename
- Signature help

## Contributing

Clone whole repository and in root directory execute:

```bash
composer install
npm install
npm run build
code .
```

The last command will open the folder in VS Code. Hit `F5` to launch an Extension Development Host with the extension.
For working on the language server, the easiest way is to replace the language server installation from composer in `vendor/felixfbecker/language-server` with a symlink to your local clone.

**For guidance on how to work on the language server, please see the [language server repository](https://github.com/felixfbecker/php-language-server).**
Initial Commit 2016-08-25 15:55:00 +00:00			`# PHP IntelliSense`

docs(badges): remove Gemnasium badge 2018-07-11 07:37:33 +00:00			[![vs marketplace](https://img.shields.io/vscode-marketplace/v/felixfbecker.php-intellisense.svg?label=vs%20marketplace)](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [![downloads](https://img.shields.io/vscode-marketplace/d/felixfbecker.php-intellisense.svg)](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [![rating](https://img.shields.io/vscode-marketplace/r/felixfbecker.php-intellisense.svg)](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-intellisense) [![build](https://travis-ci.org/felixfbecker/vscode-php-intellisense.svg?branch=master)](https://travis-ci.org/felixfbecker/vscode-php-intellisense) [![php: >=7.0.0](https://img.shields.io/badge/php->=7.0-8892BF.svg)](https://php.net/) [![chat: on gitter](https://badges.gitter.im/felixfbecker/vscode-php-intellisense.svg)](https://gitter.im/felixfbecker/vscode-php-intellisense?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
Initial Commit 2016-08-25 15:55:00 +00:00
			`Advanced PHP IntelliSense for Visual Studio Code.`
Improve README Add more links to language-server repo 2016-09-05 10:34:17 +00:00
docs(readme): add note that language server is bundled 2017-11-03 21:17:10 +00:00			`Note: This is just the VS Code extension that spawns the actual language server. The language server itself is implemented purely in PHP [in its own repository](https://github.com/felixfbecker/php-language-server), all features need to be implemented there and all issues should be reported there. You do NOT need to install it manually though, it is bundled in this extension.`
Improve README Add more links to language-server repo 2016-09-05 10:34:17 +00:00
Add Completion (#62) 2017-02-03 12:31:01 +00:00			`## Installation`

docs(badges): change badges 2017-11-03 21:15:48 +00:00			You need at least PHP 7 installed for the extension to work. You can either add it to your PATH or set the `php.executablePath` setting.
Add note about PHP 7 requirement 2016-09-09 07:07:41 +00:00
Add Completion (#62) 2017-02-03 12:31:01 +00:00			I recommend to disable VS Code's built-in PHP IntelliSense by setting `php.suggest.basic` to `false` to avoid duplicate suggestions.

Initial Commit 2016-08-25 15:55:00 +00:00			`## Features`
Add documentSymbol demo 2016-09-02 00:57:42 +00:00
Add Completion (#62) 2017-02-03 12:31:01 +00:00			`### Completion`
style: use prettier 2018-11-11 17:32:17 +00:00
Add Completion (#62) 2017-02-03 12:31:01 +00:00			`![Completion search demo](images/completion.gif)`

docs: add signature help demo gif 2017-12-10 05:55:37 +00:00			`### Signature Help`
style: use prettier 2018-11-11 17:32:17 +00:00
docs: add signature help demo gif 2017-12-10 05:55:37 +00:00			`![Signature help demo](images/signatureHelp.gif)`

Update README with new features 2016-10-26 22:36:12 +00:00			`### Workspace symbol search`
style: use prettier 2018-11-11 17:32:17 +00:00
Update README with new features 2016-10-26 22:36:12 +00:00			`![Workspace symbol search demo](images/workspaceSymbol.gif)`

			`### Find all References`
style: use prettier 2018-11-11 17:32:17 +00:00
Update README with new features 2016-10-26 22:36:12 +00:00			`![Find References demo](images/references.png)`

			`### Go to Definition`
style: use prettier 2018-11-11 17:32:17 +00:00
Update README with new features 2016-10-26 22:36:12 +00:00			`![Go To Definition demo](images/definition.gif)`

			`### Hover`
style: use prettier 2018-11-11 17:32:17 +00:00
Update README with new features 2016-10-26 22:36:12 +00:00			`![Hover class demo](images/hoverClass.png)`

			`![Hover parameter demo](images/hoverParam.png)`

Add documentSymbol demo 2016-09-02 00:57:42 +00:00			`### Find all symbols`
style: use prettier 2018-11-11 17:32:17 +00:00
Add documentSymbol demo 2016-09-02 00:57:42 +00:00			`![Find all symbols demo](images/documentSymbol.gif)`
Initial Commit 2016-08-25 15:55:00 +00:00
Update README with new features 2016-10-26 22:36:12 +00:00			`### Column-accurate error reporting`
style: use prettier 2018-11-11 17:32:17 +00:00
Update README with new features 2016-10-26 22:36:12 +00:00			`![Error reporting demo](images/publishDiagnostics.png)`

docs(features): change readme for 'format code' (new extension PHP CS Fixer) (#252) 2018-04-27 00:02:30 +00:00			`### Code style linting`
style: use prettier 2018-11-11 17:32:17 +00:00
docs(readme): remove mentions of formatting 2017-11-20 17:07:06 +00:00			`Please use a dedicated extension like [PHP CodeSniffer](https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs).`

docs(features): change readme for 'format code' (new extension PHP CS Fixer) (#252) 2018-04-27 00:02:30 +00:00			`### Format code`
style: use prettier 2018-11-11 17:32:17 +00:00
docs(features): change readme for 'format code' (new extension PHP CS Fixer) (#252) 2018-04-27 00:02:30 +00:00			`Please use a dedicated extension like [PHP CS Fixer](https://marketplace.visualstudio.com/items?itemName=junstyle.php-cs-fixer).`
Prepare for release 2016-09-04 11:13:13 +00:00
Initial Commit 2016-08-25 15:55:00 +00:00			`## Todo`
style: use prettier 2018-11-11 17:32:17 +00:00
			`- Rename`
			`- Signature help`
Prepare for release 2016-09-04 11:13:13 +00:00
			`## Contributing`

Add steps to build and run from source (#2) 2016-09-01 13:07:24 +00:00			`Clone whole repository and in root directory execute:`
style: use prettier 2018-11-11 17:32:17 +00:00
Add steps to build and run from source (#2) 2016-09-01 13:07:24 +00:00			```bash
docs(badges): change badges 2017-11-03 21:15:48 +00:00			`composer install`
Add steps to build and run from source (#2) 2016-09-01 13:07:24 +00:00			`npm install`
docs(readme): npm command in README.md should be 'run build' (#290) 2018-04-27 00:00:37 +00:00			`npm run build`
Update README 2016-09-04 09:49:49 +00:00			`code .`
Add steps to build and run from source (#2) 2016-09-01 13:07:24 +00:00			```
style: use prettier 2018-11-11 17:32:17 +00:00
Update README 2016-09-04 09:49:49 +00:00			The last command will open the folder in VS Code. Hit `F5` to launch an Extension Development Host with the extension.
Add note for symlinks 2016-09-04 09:52:07 +00:00			For working on the language server, the easiest way is to replace the language server installation from composer in `vendor/felixfbecker/language-server` with a symlink to your local clone.
Improve README Add more links to language-server repo 2016-09-05 10:34:17 +00:00
			`For guidance on how to work on the language server, please see the [language server repository](https://github.com/felixfbecker/php-language-server).`