Ignore code by dependency version

[markhuot]

Hello, I’m working on a plugin that needs to support two major versions of a dependency. When the dependency upgraded from version 4 to 5 additional code is now required in my plugin. I’ve come up with something like this,

$section = new Section();

if (version_compare(DEP_VERSION, ‘5.0.0’, ‘>=‘)) {
    $section->setEntryTypes($entryTypes);
}

$section->save();

In order for that to function I’m setting the DEP_VERSION constant in my bootstrap based on composer.lock.

Functionally this does what I want but PHPStan is getting tripped up saying:

1. the if is always false (when run on the 4.x branch)
2. section does not have a setEntryTypes method on the 4.x branch, which is correct for the 4.x branch

Is there a way to tell PHPstan it’s okay to ignore code not meant for this version?

Note: my CI is running PHPstan twice, once for the 4.x branch and once for the 5.x branch.

[ondrejmirtes]

It's a good thing you run PHPStan twice because then you can conditionally ignore different things.

PHPStan itself does it for different PHPS versions: https://github.com/phpstan/phpstan-src/blob/1.11.x/build/ignore-by-php-version.neon.php

So you can ask Composer through InstalledVersions about the version of the package and include different neon files with different ignores that way.

[markhuot]

Thank you.

In some cases that conditional is quite long so instead of ignoring multiple errors per version in one file I might separate out the conditional to an entirely separate file. Then I can ignore the entirety of “modern code” on old versions and only have to ignore the one “missing class” error where the two versions come together.