Intelephense Documentation

Intelephense follows a freemium model:

• Free Tier: All features not explicitly marked as PREMIUM are free.
• Premium Tier: Access to advanced features (like symbol renaming, type hierarchy, and code lens) requires a licence.
• Licence Details: A single licence key grants a single user access to all current and future premium features on multiple devices forever.
• Activation: Licence keys must be activated automatically via HTTPS. You can enter your key in VS Code using the command Enter licence key from the command palette.

To use Intelephense effectively in Visual Studio Code, follow these setup steps:

1. Disable built-in PHP features: To prevent conflicts, you must disable the default VS Code PHP language features.
   • Open the Extensions view.
   • Search for @builtin php.
   • Disable PHP Language Features.
   • Note: Keep PHP Language Basics enabled to maintain syntax highlighting. It is also recommended to disable any other 3rd party PHP extensions that provide similar intelligence.
2. Configure non-standard file extensions: If you use custom PHP extensions (e.g., .module), map them to the php language in your files.associations setting.
3. Activate Premium features (Optional): If you have purchased a licence, activate it via the command palette (Ctrl + Shift + P) by searching for Enter licence key.

"files.associations": {
  "*.module": "php"
}

To activate a purchased licence, use the intelephense.enter.key command.

• The key must be a 15 character alphanumeric string.
• Activation involves a POST request to intelephense.com/activate using a machine ID derived from your home directory.
• Once successfully activated, the licence information is stored in the extension's global storage.

You can tune the performance and environment of the Intelephense language server through VS Code settings under the intelephense namespace:

• intelephense.runtime: Specifies the path to a specific PHP runtime to be used by the language server.
• intelephense.maxMemory: Sets the maximum memory (in MB) for the language server. If set to 256 or higher, it applies the --max-old-space-size flag to the Node.js process.

The intelephense.shortOpenEchoAutoClose setting controls an automatic feature for PHP files. When enabled, if you type an equals sign (=) immediately following a short echo tag (<?=), the extension will automatically insert the closing tag (?>) and place your cursor inside the tags.

Example behavior: Typing <?= results in <?= ?> with the cursor positioned between the tags.

The createMiddleware() function returns an IntelephenseMiddleware object used to intercept and augment the language server's request/response pipeline. This middleware specifically handles the synchronization of VS Code workspace settings with Intelephense configuration.

Key behaviors include:

• Configuration Merging: When workspace.configuration is called, the middleware merges Intelephense settings with VS Code's files.associations and files.exclude settings. It also synchronizes php.validate.run with Intelephense diagnostics.
• CodeLens Transformation: It intercepts resolveCodeLens requests to transform raw command arguments (like URI strings) into proper VS Code Uri, Position, and Location objects, ensuring compatibility with the VS Code editor.

This middleware implements the Middleware and Disposable interfaces from vscode-languageclient.

Intelephense provides several commands that can be executed via the VS Code Command Palette to manage indexing and licensing:

• intelephense.index.workspace: Manually triggers a workspace re-index. This stops the current language client and restarts it with the cache cleared.
• intelephense.cancel.indexing: Sends a request to the language server to cancel the current indexing process.
• intelephense.enter.key: Opens an input box to enter or update your Intelephense licence key.

Retrieves the language ID of the embedded content from a virtual Uri. The language ID is stored in the authority component of the URI.

export function getEmbeddedLanguageId(virtualDocumentUri: Uri): string

The EMBEDDED_CONTENT_SCHEME constant defines the URI scheme used for virtual documents representing embedded languages within a host file. It is set to embedded-content.

export const EMBEDDED_CONTENT_SCHEME = 'embedded-content';

Checks whether a given Uri belongs to the embedded-content scheme.

export function isEmbeddedContentUri(virtualDocumentUri: Uri): boolean