Injected SQL statements

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in PhpStorm by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

1. Press Ctrl+Alt+S to open the IDE settings and then select Plugins.

2. Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

Temporarily inject a language

1. Place the caret inside a string literal, tag, or attribute, in which you want to inject a language and press Alt+Enter (or use the intention action icon ).

2. Select Inject language or reference and choose the language you want to inject.

Open a code fragment in the dedicated editor section

1. Place the caret within the injected code piece and press Alt+Enter (or use the intention action icon ).

2. Select Edit <language ID> Fragment.

   PhpStorm will open a dedicated editor section for editing the code with the injected language. This editor provides full coding assistance, including code completion, inspections, intentions and code style actions.

   

Cancel injections

1. Place the caret at the code fragment and press Alt+Enter (or use the intention action icon ).

2. Select Uninject language or reference.

Configuring sprintf Format References

You can have PhpStorm recognize sprintf format references in injected SQL strings:

1. Press Ctrl+Alt+S to open the IDE settings and then select Tools | Database | User Parameters.

2. Select the Enable in console and SQL files and Enable in string literals with SQL injection checkboxes.

3. In the Parameter Patterns list:

   1. Click the %\w+ pattern. PhpStorm expands a hidden area with the configuration settings for the pattern.

   2. Select the In scripts and In literals checkboxes.

   3. Click the <Language> link and select PHP in the list.

Configure injection rules

You can configure language injection rules on the Editor | Language Injections page of the IDE settings  Ctrl+Alt+S.

All pre-defined injection rules are configured for the Built-in scope. In other words, they are global (and therefore available in all PhpStorm projects). Custom rules can be configured for the IDE or for one project only. To change the scope of custom injections, use the Move to Project/IDE Scope icon .

To configure custom injection rules, click the Add icon to add a new rule, or copy a predefined rule and change its settings.