PhpStorm 2016.2 Help

Preparing for Joomla! Development in PhpStorm

On this page:

Before you start

  1. Download and install Joomla!.
  2. Make sure the Joomla! plugin is enabled. The plugin is bundled with PhpStorm and activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Creating a PhpStorm project with Joomla! Intergation support

You can create a PhpStorm project that will be set up and configured in accordance with the Joomla! requirements. This is done by creating a project by a Joomla! Integration template.

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
  2. In the left-hand pane, choose Joomla! Integration.
  3. In the right-hand pane, in the Location field, specify the folder where the project will be created and provide the following Joomla!-specific information:
    1. Specify the root folder of the Joomla! installation in the Joomla! installation path. Type the path manually or click the Browse button browseButton and select the relevant folder in the dialog box that opens.
    2. Select the desired Joomla! project type (component, module, or plugin).

Importing a Joomla! project

Besides creating a project anew according to the Joomla! template, you can open an existing Joomla! project in PhpStorm. PhpStorm recognizes the Joomla!-specific structure and suggests activating the Joomla! support in project.

  1. Open the folder with the required Joomla! project by choosing File | Open Directory.
  2. As soon as PhpStorm detects the Joomla!-specific structure in the project, the following message is displayed in a pop-up window:
    drupalStructureDetected
    Click the Enable link.
  3. In the Drupal Module dialog box that opens, select the Enable Drupal integration check box and proceed as when creating a project with a Drupal module:
    1. Specify the root folder of the Drupal installation in the Drupal installation path.
    2. Select the Set up PHP | Include paths check box to have Drupal include paths automatically configured for the project.
    3. From the Version drop-down list, choose the version of Drupal to use, the supported versions are 6, 7, and 8 .

You can update integration settings at any time later in the File | Settings for Windows and Linux or PhpStorm | Preferences for OS X.

Last modified: 8 July 2016