Skip to content
PHPSTorm Live Templates (aka code snippets) for Drupal 7
Perl
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
README.md
parse_drupal_api.pl
user.xml

README.md

PHPStorm Live Templates for Drupal 7

What ? Why ?

Lazy programmers (i.e. every programmer) like to use code snippets. The goal is to write less code and program faster. IDE's (or text editors like VIM) allow the use of such snippets to write for us commonly used functions.

The purpose of these Live Templates is to provide Drupal devs such templates for Drupal hooks. It was generated using a Perl script that basically create PHPStorm Live Templates from *.api.php files in Drupal /includes and /modules directories. The output is a bit raw, so it needs some love and polish.

How to use the script generator

You need Perl in your machine. This script was written under Debian Linux, so it may need some adaptations for others OS's.

Type these commands :

$ cd /path/to/drupal  
$ find . -name \*.php | xargs grep -l '^function hook_' | xargs /path/to/parse_drupal_api.pl > ~/.WebIde10/config/templates/user.xml

How to use the Live Templates

  1. (optional) For security's sake, back up your original user.xml file if it exists.
  2. Copy the user.xml file into ~/.WebIde10/config/templates
  3. Restart PHPStorm.
  4. Type h_HOOKNAME<tab> for short version, hook_HOOKNAME<tab> for annoted version (with core comments)
  5. Profit !

License

Copyright (C) 2011 Jeremie Le Hen jeremie@le-hen.org

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Credits

Props to Jeremie Le Hen who wrote the Perl script that generated the templates.
Special thanks to blup for the original idea and work (VIM snippets for Drupal)

Something went wrong with that request. Please try again.