PhpStorm 2021.2 Help

Extract Constant Dialog

Item

Description

Name

In this field, specify the name of the new constant.

Replace all occurrences

Select this checkbox to have PhpStorm automatically replace all the occurrences of the selected expression (if the selected expression is found more than once in the method).

Constant syntax

In this area, choose the method to define the PHP constant. The area is available only when the refactoring is invoked outside a class definition because the choice itself is relevant only in this context: extracted class constants are defined through the const keyword only.

  • define: choose this option to have PhpStorm define the constant through the define() function.

  • const: choose this option to have PhpStorm define the constant through the const keyword.

    This method preserves the approach accepted in PHP version 5.3.0. Note that such constants are defined during compilation therefore they should be declared at the top-level scope but not inside functions, loops or if statements.

Visibility

In this area, choose the visibility scope (access level modifier) of the extracted constant. If you leave the default value selected, the constant will be implicitly defined as public without any modifier applied to it. Otherwise, you can choose the appropriate option to explicitly mark the constant as public, private, or protected.

The area is available only when language level is set to PHP language version 7.1 and later. You can specify the PHP language level on the PHP page of the Settings/Preferences dialog Ctrl+Alt+S.

Target class

Select the checkbox to introduce a constant in a different class. Then provide the class name in the field.

Last modified: 08 March 2021