PhpStorm 2019.2 Help

Move and Copy refactorings

The Move refactoring allows you to move classes, class members (methods, fields, and constants), regular functions and constants, files, and directories within a project. In doing so, PhpStorm tracks these movements and automatically corrects all references to the moved symbols in the source code.

Moving a file or a directory to another directory

  1. Select the file or directory in the Project tool window.

  2. Do one of the following:

    • From the main menu, choose Refactor | Move.

    • From the context menu of the selection, choose Refactor | Move.

    • Press F6.

    The dialog that opens depends on the type of the selected symbol.

  3. In the To directory field, specify the folder to move the selected file or folder to. Choose an existing folder from the list or type the full path to the parent folder to be created.

  4. To have the references to the selected file or folder updated according to the refactoring result, select the Search for references checkbox.

Moving a PHP namespace

PhpStorm supposes that the namespaces in your project are arranged in compliance with the PSR0 standard and enforces you to retain the folder structure and the namespace hierarchy in accordance with this standard when moving namespaces.

When you specify a namespace to move a namespace to, PhpStorm automatically updates the Target Destination Directory field, which shows the path to the folder that corresponds to the namespace.

To move a namespace with all or some of its related classes to another namespace

  1. In the editor, position the caret at the namespace to move and choose Refactor | Move from the main menu or the selection context menu. Note that if you select the folder that corresponds to the required namespace in the Project tool window and then choose Refactor | Move, the Move Directory refactoring will be invoked.

  2. In the Move Namespace Dialog that opens, specify the new namespace name and the folder that will correspond to it.

    • The New Namespace Name field shows the fully qualified name of the selected namespace. Specify the new namespace name. Use only backslashes \ as namespace separators.

    • When the dialog opens, the Target Destination Directory field shows the path to the folder corresponding to the current namespace.

      The path is displayed in the following format:

      ...\<project root>\<current namespace folder relative to the project root>
      The path is updated automatically as you specify the new namespace name. However, if you are going to move a namespace to another parent namespace, PhpStorm will not suggest the proper folder unless you appoint a root folder for your namespace structure by marking the relevant folder as Sources on the Directories page of the Settings/Preferences dialog (Ctrl+Alt+S). See Directories for details.

      Do one of the following:

      • Accept the preselected path displayed in the field.

      • Choose another path from the list. All of them are evaluated from the namespace root or from the current directory, so it is safe to choose any of them.

      • Click the Browse button and select a folder in the dialog that opens.

      • Press N/A and edit the preselected path. Keep in mind that this may cause problems with automatic loading in the future.

  3. Click Refactor and in the Move Files with Related Namespaces dialog that opens specify the classes and files to be moved to the new namespace and the new folder.

    The upper pane of the dialog lists the destination namespaces and folders for classes and files related to the namespace. Each item in the list corresponds to a class/file. When you move the cursor to an item, the bottom pane shows the contents of the file related with it.

    the Move Files With Related Namespaces dialog
    • To have a class and the corresponding file moved to the destination namespace and the destination folder, select the checkbox next to the namespace/folder.

    • To add all the items to the list or remove all of them from the list, click Select All or Unselect All respectively.

  4. Click OK to start the refactoring.

Moving a static PHP method, variable, or constant to another class

  1. Open a PHP class in the editor place the caret at a static method, variable, or constant.

  2. From the main menu or the editor context menu, select Refactor | Move.

  3. In the Move Static Member Dialog that opens, specify the following:

    1. In the Members to be moved to another class field, select the checkboxes next to the methods, constants, and variables that you want to move to another class. The list shows all the static methods, variables, and constants detected in the current class.

    2. In the Move Member To Class field, type the fully qualified name of the class where you want to move the members selected in the Members to be moved to another class list. PhpStorm provides completion for the class and namespace reference: as you type a class or namespace name, a suggestion list with the relevant item is displayed. You can also get a full list of available classes by pressing Ctrl+Space.

Moving a function or constant from a PHP file to a class

  1. Do any of the following:

    • To move a single constant or function, open a PHP file in the editor and place the caret at a constant or function.

    • To move several constants or functions at once, open a PHP file in the editor and select the constants or functions to move in the Structure tool window (Alt+7) or the structure view popup (Ctrl+F12).

      Select several constants to move in the Structure popup
  2. From the main menu or the editor context menu, select Refactor | Move or press F6.

  3. Depending on your selection, the Move Constant or Move Function dialog opens.

    In the dialog, type the fully qualified name of the class where you want to move the selected constant or function. PhpStorm provides completion for the class and namespace reference: as you type a class or namespace name, a suggestion list with the relevant item is displayed. You can also get a full list of available classes by pressing Ctrl+Space.

Moving an instance PHP method to another class

The Move instance method refactoring moves an instance (non-static) method to another class.

To move an instance PHP method to another class

  1. In the editor, position the caret at an instance method and either do one of the following:

    • From the main menu or context menu, choose Refactor | Move.

    • Press F6.

  2. In the Move Instance Method dialog that opens, specify the following:

    • In the Select an instance expression list, select the target class to move an instance method to. The list of potential move targets includes the method parameters' classes and fields' classes in the current class.

    • In the Visibility area, select the preferred visibility modifier for the target method.

    • In the Parameter name to replace the $this reference to class <class_name> field, type the desired name of the parameter. When refactoring is performed, the parameter will be added for the method being moved, which will replace all $this references to the current class.

    Move Instance Method Dialog

  3. Initiate refactoring by clicking Refactor or Preview. For more details, see Refactoring code.

Example

Let's move the foo instance method from class B to class A. As a result, PhpStorm will move the method and replace the $this reference to class B with created $b parameter:

Before

After

class A{ } class B { function foo(A $a) { $this->bar(); return $a; } public function bar(){ } }
class A { function foo(B $b) { $b->bar(); return $this; } } class B { public function bar() { } }

Moving a class to another namespace

PhpStorm supposes that the namespaces in your project are arranged in compliance with the PSR0 standard and enforces you to retain the folder structure and the namespace hierarchy in accordance with this standard when moving classes among namespaces.

When you specify a namespace to move a class to, PhpStorm automatically updates the Target Destination Directory field, which shows the path to the folder where the file that implements the class in question will be stored.

To move a class to another namespace

  1. In the editor, place the caret at the class to move.

  2. Do one of the following:

    • From the main menu, choose Refactor | Move.

    • From the context menu of the selection, choose Refactor | Move.

    • Press F6.

  3. In the Move Class dialog, that opens, specify the namespace to move the class to and the folder where the file that implements the class will be stored.

    1. In the Move Class <class name> to Namespace field, appoint the namespace to move the selected class to. This can be:

      • A new namespace under the current namespace.

      • Another subordinate namespace under the current parent.

      • An existing or a new namespace under another parent.

      In any case, the import statements referencing the class are updated accordingly.

    2. In the Target Destination Directory field, appoint the folder where you want PhpStorm to move the file that implements the class.

      PhpStorm supposes that the namespaces in your project are arranged in compliance with the PSR0 standard and enforces you to retain the folder structure and the namespace hierarchy in accordance with this standard when moving classes among namespaces.

      When you specify a namespace to move a class to, PhpStorm automatically updates the Target Destination Directory field, which shows the path to the folder file that implements the class in question.

      When the dialog opens, the field shows the path to the folder corresponding to the current namespace.

      The path is displayed in the following format:

      ...\<project root>\<current namespace folder relative to the project root>
      The path is updated automatically as you specify the new namespace name. However, if you are going to move a namespace to another parent namespace, PhpStorm will not suggest the proper folder unless you appoint a root folder for your namespace structure by marking the relevant folder as Sources on the Directories page of the Settings/Preferences dialog (Ctrl+Alt+S). See Directories for details.

      Do one of the following:

      • Accept the preselected path displayed in the field.

      • Choose another path from the list. All of them are evaluated from the namespace root or from the current directory, so it is safe to choose any of them.

      • Click the Browse button and select a folder in the dialog that opens.

      • Press N/A and edit the preselected path. Keep in mind that this may cause problems with automatic loading in the future.

    3. The Move class to a new file checkbox is selected. Leave this default selection.

  4. Initiate refactoring by clicking Refactor or Preview, for more details, see Refactoring code.

Copy refactoring

The Copy refactoring allows you to copy a class, file, or directory with its entire structure from one directory to another.

Copy a class, file, or directory

  1. Select the desired item in one of the views or open it in the editor.

  2. Do one of the following:

    • From the main menu or the selection context menu, choose Refactor | Copy.

    • Press F5.

    • Select the desired class in the Project tool window and drag it to the target destination with Ctrl pressed.

  3. In the Copy dialog that opens specify the new name and destination, then click OK.

Last modified: 18 November 2019