Language Injection Settings: Generic PHP

Name

The name of the injection.

Language

The language to be injected.

• ID. The language ID or name.

• Prefix. A sequence of characters to be added before the corresponding string value.

• Suffix. A sequence of characters to be added after the corresponding string value.

The prefix and suffix are optional.

Places Pattern

In this field, 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 an internal PhpStorm language. The Program Structure Interface shows the structure of a file as PhpStorm treats it.

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 to enable more fine-grained control over the injection process.

• Value pattern - in this field, 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 - If the option is off, the fragments that match the value pattern are treated separately, as different "files" - for example from the fragment editor's viewpoint.

  If the option is on, the corresponding fragments are all merged together to form a single unit, or "file".

  Given the value pattern

  xxx (.+) yyy (.+) zzz

  and the fragment

  xxx select * yyy from family zzz,

  select * and from family are treated as two independent fragments (or "files") if the option is off. If the option is on, select * from family is treated as a single unit or "file".