hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity
intellij-sdk-code-samples/products/phpstorm/phpstorm.md
JohnHake 80129a7641 New Copyright in markdown files
2020-02-19 22:25:03 -08:00

3.3 KiB
Raw Blame History

title redirect_from
PhpStorm Plugin Development
/phpstorm/phpstorm.html
/phpstorm/setting_up_environment.html
/products/phpstorm/setting_up_environment.html

Introduction

PhpStorm is an IntelliJ Platform-based product. Plugins for PhpStorm are developed in Java using the Ultimate edition of IntelliJ IDEA. The PsiViewer plugin is also recommended.

This page describes configuring plugin projects targeting PhpStorm. See also:

Configuring Plugin Projects Targeting PhpStorm

The IntelliJ IDEA Ultimate Edition (with the PHP plugin) must be used for developing PhpStorm plugins because the PHP plugin is incompatible with IntelliJ IDEA Community Edition. However, this IntelliJ IDEA Ultimate configuration runs the risk of accidentally using some APIs that are not available in PhpStorm. The recommended best practice is to use PhpStorm for testing.

Note

The OpenAPI is available for PhpStorm 6 and above.

Configuration of a Gradle-based PhpStorm plugin project is used as a tutorial in the section Configuring Plugin Projects using the IntelliJ IDEA Product Attribute. Many techniques are discussed, such as choosing a version of IntelliJ IDEA Ultimate given a targeted version of PhpStorm. The table below summarizes the gradle-intellij-plugin attributes to set in the build.gradle file for a PhpStorm plugin project:

gradle-intellij-plugin Attribute
Attribute Value
intellij.type IU for IntelliJ IDEA Ultimate. (The required PHP plugin isn't compatible with IntelliJ IDEA Community Edition.)
intellij.version Set to the same IU BRANCH.BUILD as the PhpStorm target version, e.g. 193.5233.102
intellij.plugins com.jetbrains.php:193.5233.102 for the PHP plugin.
See below for PHP plugin version information.
runIde.ideaDirectory Path to locally installed target version of PhpStorm. For example, on macOS:
/Users/<user name>/Library/Application Support/JetBrains/Toolbox/apps/PhpStorm/ch-0/193.5233.101/PhpStorm.app/Contents

The version of the PHP plugin is explicitly declared because it isn't bundled with IntelliJ IDEA Ultimate Edition. Select a version of the PHP plugin that is compatible with the intellij.version.

The dependency on the PHP plugin APIs must be declared in the plugin.xml file, as shown in the tutorial Configuring plugin.xml section.