Any way to whitelist or ignore PHP constants?

snowcreative

I have a PHP constant that I use frequently in Visual Studio Code, and I don't want it to be flagged everywhere as undefined, because I know when the scripts go live the constant will already be defined. The constants are defined in the MODX config file on the server that loads before any custom coding loads. Is there any way to "whitelist" a constant, or ignore it?

JakubMisek

snowcreative Thank you for the question.

There are two approaches:

you can create a fake file, for example .stubs.php, and add a fake definition:

<?php const C = 123;

or you can disable the warning 0415 using .vscode/settings.json file:

"php.problems.exclude" : {
    "/" : [415],
}

snowcreative

Great, thanks. I entered it as a setting. But, if I created the file, where would I put it? Wouldn't that have to be included somewhere in the scripts to trigger the definition?

JakubMisek

snowcreative

The editor does not track the "include" paths, it indexes all the .php files in VSCode's workspace; So you can put the "stubs" file(s) anywhere as long as it is in your project folder. No need to add include ".."; to it.

A common practice is something like .editor.meta.php in the project root.

snowcreative

Thanks so much for the info!

JakubMisek

snowcreative I'm glad if it helps, please let us know if there will be anything else we can help with, or if we can improve something!