PhpStorm 2023.3 Help

Phing build tool window

Accessing the Phing Build Tool Window

  • Open a Phing build file in the editor or select it in the Project tool window, and then choose Add as Phing build file from the context menu of the selection.

  • Choose View | Tool Windows | Phing Build from the main menu. The tool window can be accessed after you have opened it through the context menu of a Phing build file in the editor or in the Project tool window.

In this tool window:

  • Specify the location of the phing.bat file.

  • Configure a list of Phing build files for packaging, deploying, or testing PHP applications.

  • Appoint targets to be executed before running or debugging according to specific configurations.

  • Run entire build files and specific build targets.

The functionality of the Phing tool window is available through the toolbar buttons > and the context menu of a build file or target.

Toolbar

Item

Tooltip and shortcut

Description

Add

Click this button add a new script to the list. In the Select Phing Build Script dialog that opens, choose the desired file.

Remove

Click this button to remove the selected build file from the list.

Run

Click this button to run the selected build file or target.

Expand all

Ctrl+NumPad +

Click this button to have PhpStorm show a tree of targets defined in the selected build file.

Collapse all

Ctrl+NumPad -

Click this button to have PhpStorm collapse all the targets in the selected build file.

properties.gif

Properties

Click this button to have the Phing Properties dialog opened. In this dialog, specify the location of the phing.bat file.

If necessary, configure the build procedure and the format of the output by specifying command line arguments in the Command Line Options field. If the set of arguments is too large to fit in the field, click the button or press Shift+Enter and type the desired arguments in the Command Line Options dialog, that opens.

The button is only available if the list of build files is not empty.

Context Menu

Item

Description

Available for

Run Build

Choose this option to have the selected build file executed.

Build files

Run Target

Choose this option to have the selected build target executed.

Build targets

Jump to Source

Choose this option to navigate to the source code of the selected build file or to the definition of the selected target.

Build files

Build targets

Remove

Choose this option to remove the selected build file from the list.

Build files

Before Run/Debug

Choose this option to have the selected build target always executed before running or debugging the project according to specific run/debug configurations. In the Execute Target Before Run/Debug dialog that opens, select the configurations before which you want the target executed.

Build targets

Assign shortcut

Choose this option to open the Keymap dialog and configure a keyboard shortcut for the selected target as described in Keyboard shortcuts.

Build targets

Mark to hide

Choose this option to make the selected target hidden and thus suppress showing it in the build file tree. This may be helpful when you have targets some that are only called by other ones and are never run alone.

Hidden targets do not become visible when you expand the node of a specific build file or click Expand All button the Expand All button. To remove the hidden status of a target:

  1. Select the build file in which it is defined and click the Settings Preferences button the Properties button on the toolbar.

  2. In the Phing Settings dialog that opens, switch to the Hiding targets tab where the Hide checkboxes next to the names of the hidden targets are selected. Clear the Hide checkboxes next to the targets for which you want the status hidden removed.

Build targets

Properties properties.gif

Click this button to have the Phing Properties dialog opened. In this dialog:

  • Specify the location of the phing.bat file.

  • If necessary, configure the build procedure and the format of the output by specifying command line arguments in the Command Line Options field. If the set of arguments is too large to fit in the field, click the button or press Shift+Enter and type the desired arguments in the Command Line Options dialog, that opens.

  • In the Hiding Targets tab, mark targets for hiding and remove the hidden status.

    Among the targets defined in a build file, you may have some that are only called by other targets and are never run alone. You can suppress showing such targets in the build file tree by marking them as hidden.

    Hidden targets do not become visible when you expand the node of a specific build file or click Expand All button the Expand All button.

The button is only available if the list of build files is not empty.

Build files

build targets

Last modified: 04 March 2024