PHPStorm for ProcessWire Developers

[FrancisChung]

PHPStorm for PW Devs

This thread is a place for ProcessWire developers who use PHPStorm to share their experience, tips, frustrations, solutions, code snippets and generally discuss all things PHPStorm.

From Wikipedia:

JetBrains PhpStorm is a commercial, cross-platform IDE for PHP^[1] built on JetBrains' IntelliJ IDEA platform.

PhpStorm provides an editor for PHP, HTML and JavaScript with on-the-fly code analysis, error prevention and automated refactorings for PHP and JavaScript code

 

Thanks @kongondo for the Visual Studio Code post earlier.

[FrancisChung]

Previous Related Topics to PHPStorm :

XDebug :

 

 

Autocompletion :

 

PHPUnit:

 

[Robin S]

Does anyone know if it's possible to do something to "tell" PhpStorm how PW uses a template file and what variables are in scope there? For the purposes of code completion and to avoid erroneous undeclared variable warnings.

Currently I manually list all API variables and variables declared in the auto-prepended _init.php inside a DocBlock at the top of every template file. This works but gets pretty tiresome, especially when you need to make a change globally.

What would be cool is if PhpStorm could "know" that all API variables are available in every template file and that _init.php is prepended and so all the variables declared there are in scope. Anyone know a way to achieve this?

BTW, for API variables the Functions API is a no-go for me because I dislike all the string concatenation that goes with it. 

[maxf5]

Quote

Does anyone know if it's possible to do something to "tell" PhpStorm how PW uses a template file and what variables are in scope there?

+1 for that!

Still waiting for a ProcessWire Plugin for PhpStorm.

All those lints are horrible

[FrancisChung]

I forgot about this .... everyone should upvote this to get a chance of being implemented.

https://youtrack.jetbrains.com/issue/WI-36647

Or even better, any Java/PW gurus out there?

[cstevensjr]

2 hours ago, FrancisChung said:

I forgot about this .... everyone should upvote this to get a chance of being implemented.

https://youtrack.jetbrains.com/issue/WI-36647

Or even better, any Java/PW gurus out there?

Gave it a vote

[Mike Rockett]

8 hours ago, maxf5 said:

Still waiting for a ProcessWire Plugin for PhpStorm.

VS Code is in need of one too.

[maxf5]

DEL

[FrancisChung]

@maxf5, I tried about a year ago but I couldn't get it to work.
I assume you're on the latest build of PHPStorm?

[maxf5]

Hi @FrancisChung, yes i am on the latest version (2017.3.2).
Maybe let's read some PHPStorm documentations to make it run.

[FrancisChung]

21 hours ago, maxf5 said:

Hi @FrancisChung, yes i am on the latest version (2017.3.2).
Maybe let's read some PHPStorm documentations to make it run.

I had another read, and I think the best course of action try and reverse engineer a working plugin?

https://github.com/topdown/phpStorm-CC-Helpers
 

[Robin S]

Just sharing a tip...

PhpStorm had slowed down to a crawl, disk usage was regularly at 100% and the interface was sluggish to the point it was almost unusable. After some googling I found a suggestion to try restarting using the Invalidate Caches option and it has made a huge difference. Now everything is snappy and fast again. 

More info here, and be sure to read and understand the warnings, especially the fact that your local history will be erased.

[FrancisChung]

Awesome tip, @Robin S

Local history is something I use quite regularly but I suppose I should be committing more often as per the Git mantra

Perhaps users who rely on local history can make a backup of the System Cache first before invalidating the cache and seeing what sort of performance gains they get. 

The locations are :

Windows
	<User home>\.PhpStormXX\system that stores PhpStorm data caches.

Linux
	~/.PhpStormXX/system that stores PhpStorm data caches.

macOS
	~/Library/Caches/PhpStormXX contains data caches, logs, local history, etc. These files can be quite significant in size.

Source : https://www.jetbrains.com/help/phpstorm/project-and-ide-settings.html

[geekpete]

Hi All,

Wonder if anybody can offer any advice on using PHPStorm and auto completion?

I'm in a standard template file and if I type say $page-> and ask for some suggestions via Control-Space I get a 'no suggestions' tooltip.  I've just learn't about the functions API which seem to autocomplete just fine.  Just can't seem to get the variables based API working.  Am I doing something wrong?

I see Ryans .phpstorm.meta.php file in /wire/core and am thinking the 2nd section being noted about not working might be causing the problem?

I'm still a little new to PHPStorm but the project all seems setup and working fine just not this part.  I've attached mini screenshots what I see when trying to auto complete with both the functions API and the variables one.

All the examples I come across seem to use the variables API and not the functions one, any big reason not to use it?  I'm no PHP expert so I might not be understanding an obvious 'don't use scenario', be gentle lol

Cheers All.

** A little addition, whilst the functions API is autocompleting for functions like children() and the template field 'title'  If I add a custom field I don't see it in the autocomplete list?  I'm not quite sure how PHPStorm can pull in those fields in the right context so I'm thinking my understanding is wrong on how this all works!  Seems a shame to use an IDE with such strong code inspection etc for PHP and not be able to use it as much as possible in the template files **

[Robin S]

19 hours ago, geekpete said:

Just can't seem to get the variables based API working.

PhpStorm doesn't know what API variables PW makes available to template files. So you need to add variable types hints in a DocBlock at the top of your template files. I use...

/**
 * @var Config $config
 * @var Fieldgroups $fieldgroups
 * @var Fields $fields
 * @var Languages $languages
 * @var Modules $modules
 * @var Page $page
 * @var Pages $pages
 * @var Paths $urls
 * @var Permissions $permissions
 * @var ProcessWire $wire
 * @var Roles $roles
 * @var Sanitizer $sanitizer
 * @var Session $session
 * @var Templates $templates
 * @var User $user
 * @var Users $users
 * @var WireCache $cache
 * @var WireDatabasePDO $database
 * @var WireDateTime $datetime
 * @var WireFileTools $files
 * @var WireInput $input
 * @var WireLog $log
 * @var WireMail $mail
 * @var \ProCache $procache
 * @var \FormBuilder $forms
 **/

 

19 hours ago, geekpete said:

If I add a custom field I don't see it in the autocomplete list?

Your field names are not a part of the PW API (field names don't exist in the file system but only in the database). But I believe you can get code completion for field names using the Template Stubs module.

[geekpete]

Thank you @Robin S Understand completely.  The TemplateStubs module looks interesting, I will be sure to check it out!