PhpStorm 6.0.1 Web Help

File | Settings | Project Settings | Language Injection - PHP

settings

PhpStorm | Preferences | Project Settings | Language Injection - PHP

settings

The dialog box opens when you click add.png   in the Language Injection page, and choose Generic PHP on the context menu, or select an entry and click properties.gif.

Warning

PhpStorm comes with a set of predefined injection configurations which is quite sufficient to ensure high productivity and comfortable environment. Therefore it is strongly recommended that you use the predefined injection configurations and avoid creating new ones.

ItemDescription
Display Name In this text box, type the name that will identify the injection configuration in the list.

Note

The text box is available only during configuration creation.

Language In this area, specify the language of the injection. If necessary, define the context to be automatically made up when the injection is opened in the editor.
  • ID - from this drop-down list, select the ID of the language of the injection.
  • Prefix - in this text box, specify the character string to be automatically added before the injection.
  • Suffix - in this text box, specify the character string to be automatically added after the injection.

Note

The Prefix and Suffix text boxes are optional.

Places Pattern In this text box, type the rules that define the context where you want PhpStorm recognize literals as injections.

Note

The rules are built from Program Structure Interface Patterns and are actually chained calls of methods of a Groovy-like internal PhpStorm language. The Program Structure Interface shows the structure of a file as PhpStorm treats it. For more information on the syntax used, refer to Custom Plugin Development guide.

Warning

These rules are PhpStorm internals, and it is strongly recommended that you use the predefined injection configurations and avoid creating new ones.

Advanced In this area, specify additional settings to narrow the context where the injection is applicable and thus the enable more fine-grained control over the injection process.
  • Value Pattern - in this text box, type a regular expression that determines the context to inject the language into. By using the first capturing group of the pattern as the target for injection, you can configure the procedure to have the language injected only into values that match a certain pattern or into multiple parts that match the pattern. For example, ^javascript:(.*) matches the javascript protocol that can be used in hyperlink-hrefs to execute JavaScript code.
  • Single File - select this check box to specify an exact file to apply the injection to. Type the name of the file in the Value Pattern.

See Also

Concepts:

Reference:

Web Resources: