Renaming Elements

To rename an element within the editor:

1. Ensure the 'Rename in editor without dialog' checkbox is marked in the Code Refactor Preferences page (accessible from Window | Preferences | PHP | Code Refactor).

2. In the editor, place your cursor on the element to be renamed.

3. From the menu bar select Refactor | Rename -or- right-click and select Refactor | Rename -or- press Alt-Shift-R.
   All occurrences of the element are put in a frame and the Refactor popup is displayed.

4. Type the new element name in the box.
   All occurrences of the element name are automatically updated.

Note:

To preview the changes before applying them, click the arrow in the right-hand corner of the Refactor popup and select Preview.

5. Click Enter to apply the refactoring.
   A  dialog is displayed prompting you to save the file before the refactoring is applied.

6. Mark the 'Always save all modified resources automatically prior to refactoring' checkbox so that the dialog will not be displayed again.

7. Click OK.

The element will be renamed and all instances where that element is referenced will be updated to reflect the changes.

To rename an element through the Refactor dialog:

1. Ensure the 'Rename in editor without dialog' checkbox is unmarked in the Code Refactor Preferences page (accessible from Window | Preferences | PHP | Code Refactor).

2. In the editor, place your cursor on the element to be renamed or select it in the PHP Explorer.

3. From the menu bar select Refactor | Rename -or- right-click and select Refactor | Rename -or- press Alt-Shift-R
   The Rename dialog box will be displayed. The name of the dialog will be dependent on the element type.

2. Enter the element's new name. You must enter a valid name for the required element - i.e. one that starts with a letter or underscore, followed by any number of letters, numbers, or underscores.

3. Check the "Update textual occurrences in comments and strings" box if you want the element's name to be updated in all comments and strings where it is referenced.
   This will force you to preview the changes before applying them.

4. Click OK to apply your changes or click Preview if you want to see a preview of the changes that this refactoring will create.

5. If you clicked preview a preview window will open with a changes tree showing all the changes which will be made to reflect the rename of the element.
   The changes will be listed according to the context within which they appear. You can therefore expand the nodes to see all changes within particular files, classes or functions.

6. Use the Next / Previous Change arrows to scroll through all possible changes.
   Unmarking the checkboxes next to the changes will cause those changes not to take effect.

Note that if changes will be made in other files which reference the element being refactored, the changes will also be listed here under the file name.

7. The changes to be applied will be displayed in the bottom pane.
   You can scroll through the different changes using the scrolling arrows:

8. Next / Previous Difference scrolling arrows - Scroll through changes to be applied within the element selected in the top pane.

9. Next / Previous Change scrolling arrows  - Scroll through all changes to be applied. If you unmarked changes in the top pane, these will not be displayed when using these arrows.

8. Once you are satisfied with the changes, click OK.

The element will be renamed and all instances where that element is referenced will be updated to reflect the changes.

Related Links:

Refactoring

Working with the Refactoring Feature

Using Refactoring

Renaming Files

Refactor Menu