Using PhpStorm

[torvista]

The inspections in PhpStorm flag up constants that it cannot find, such as those in the database, as errors.

As far as I can tell, the only way to stop these errors is to have the database constants (configuration_keys) duplicated in a file that PhpStorm CAN find/index.

So I did a script that generates a suitable file:
https://github.com/torvista/zen-cart...tion-constants

Constructive criticism welcome!

[DrByte]

Great idea.

As for naming convention, I have both my .gitignore and my FTP app set to ignore all "dev-*.php" files, so that they aren't committed to VCS nor uploaded to servers.
Alternatively, other utility tools often use underscore prefixes, for example one of them is: _ide_helper.php
(I avoid using dot-prefixed files for semi-sensitive things like this, just in case I accidentally ignore them because they're hidden-by-default.)

[torvista]

Is there any way to get these sql inspections to work, instead of switching them off?

[mc12345678]

Is there any way to get these sql inspections to work, instead of switching them off?

I haven't tried it in a while, but supposedly if a connection to a database was made, then those type of notifications would go away. I found this related to making that connection: https://www.jetbrains.com/help/phpst...-database.html

Last time I tried to do this a couple of years ago I ran into some sort of issue that I'm sure was my fault or doing.

[torvista]

The problem is not the database connection (that is working ok), but that PhpStorm cannot read/substitute the database constants in those queries for the constant definitions in
includes/database_tables.php with the DB_PREFIX.

So, this does not work:
define('TABLE_PRODUCTS', DB_PREFIX . 'products');

but this does work (clears the error)
define('TABLE_PRODUCTS', 'products');

web searches indicate this is not possible, I was just wondering if anyone had found a way to make it work without changing includes/database_tables.php.

[torvista]

There is a PHP inspection plugin for Phpstorm called EA Extended: another world of php nitpicking to spend endless hours with, but the principal things it spits out are

recommending strict comparisons when possible.
ie.
if ($action == 'edit')...
to
if ($action === 'edit')...

and using single quotes around sql text chunks

As there are so many of them to initially correct, it's hard to see any real issues (can't see the wood for the trees).

For ongoing code/PR submissions, should I "correct" these things or ignore them?

[lankeeyankee]

The problem is not the database connection (that is working ok), but that PhpStorm cannot read/substitute the database constants in those queries for the constant definitions in
includes/database_tables.php with the DB_PREFIX.

So, this does not work:
define('TABLE_PRODUCTS', DB_PREFIX . 'products');

but this does work (clears the error)
define('TABLE_PRODUCTS', 'products');

web searches indicate this is not possible, I was just wondering if anyone had found a way to make it work without changing includes/database_tables.php.

Did you ever find a workaround? I have modified includes/database_tables on my local install to avoid the issue.

[lankeeyankee]

There is a PHP inspection plugin for Phpstorm called EA Extended: another world of php nitpicking to spend endless hours with, but the principal things it spits out are

recommending strict comparisons when possible.
ie.
if ($action == 'edit')...
to
if ($action === 'edit')...

and using single quotes around sql text chunks

As there are so many of them to initially correct, it's hard to see any real issues (can't see the wood for the trees).

For ongoing code/PR submissions, should I "correct" these things or ignore them?

I'll have to install that, thanks for pointing it out. I think it's important moving forward to future-proof so think making the changes as the code is being worked on would be the best way. That's what I've been doing, and the amount of warnings when the log all errors mod is on is steadily shrinking.

[torvista]

Did you ever find a workaround?

No. I did the same.

[torvista]

To prevent php inspection flagging up multiple errors as "undefined variables" for uses of messagestack and zco_notifier, you can add this to the start of the file you are working on, temporarily:

/**
* @var messageStack $messageStack
* @var zcObserverLogEventListener $zco_notifier
*/