PhpStorm 8.0.2 Help

Refactoring Source Code

PhpStorm offers a wide variety of code refactorings, which track down and correct the affected code
references automatically.

In this part you will find:

General refactoring procedure

Procedures and examples of the available refactorings

To perform refactoring, follow these general steps

Select a symbol or code fragment to refactor. The set of available refactorings depends
on your selection. You can select symbols in the following PhpStorm components:

Project view

Structure tool window

Editor

UML Class diagram

Do one of the following:

On the main
Refactor
menu or on the context menu of the selection,
choose the desired refactoring or press the corresponding keyboard shortcut (if any).

On the main menu, choose
Refactor | Refactor This , or press
Ctrl+Shift+Alt+T, and then select the desired refactoring
from the pop-up window.

In the dialog box that opens, specify the refactoring options.

To apply the changes immediately, depending on the refactoring type, click
Refactor
or
OK.

For certain refactorings, there is an option of previewing the changes prior to
actually performing the refactoring. In such cases the
Preview
buttons is available in the corresponding dialog.

To preview the potential changes and make the necessary adjustments, click
Preview. PhpStorm displays the changes that are going to be made
on a dedicated tab of the
Find tool window.

One of the possible actions at this step is to exclude certain entries from the refactoring.
To do so, select the desired entry in the list and press
Delete.

If conflicts are expected after the refactoring, PhpStorm displays a dialog with
a brief description of the encountered problems. If this is the case, do one of the following:

Ignore the conflicts by clicking the
Continue
button. As a result, the refactoring will be performed, however,
this may lead to erroneous results.

Preview the conflicts by clicking the
Show in View
button.
PhpStorm shows all conflicting entries on the
Conflicts
tab in the
Find tool window,
enabling you to navigate to the problematic lines of code and to make the necessary fixes.

Cancel the refactoring and return to the editor.

When you are satisfied with the proposed results, click
Do Refactor
to apply the changes.