phpStorm live templates (code snippets)

phpStorm has a wonderful feature called Live Templates that lets you quickly and easily define code templates (what I usually refer to as a snippet) for code you frequently have to write. For example:

  1. Foreach loops on a standard array of entities ($entities)
  2. Symfony isGranted checks via security.context
  3. Getters or setters that aren’t for standard properties
  4. Try/Catch blocks

And the list goes on..

Fortunately in phpStorm we can make this incredibly quick and easy:


 

Open phpStorm, and select phpStorm > Preferences from the menu. Within preferences, select Live Templates about 1/3 from the bottom.

01-preferences

Next, we need to add the new template (snippet) to the selected context. Select the language/environment you want to add to. Now click the “+” and then “Live Template” to create a new live template for the selected section.

02-add

Now define your template. Select the languages it applies to, and give it an abbreviation and a description. The abbreviation will also map the keystrokes you use later to access this template.

03-define

The easy part is writing the snippet itself. This example is an Entity class with a standard $id property and getter.

04-code

When you’ve saved from the previous step, all that’s left is to access the template in your files. In this example, I’ve selected PHP so all phpStorm looks for is the <?php tag to define the file as part of the PHP context. Once done, you simple click CMD+J and begin typing the abbreviation you used earlier. Select the template when you’ve found it, and voila.

05-call

Leave a Reply

Your email address will not be published. Required fields are marked *