IMPORTANT: The PHPCompatibility 10.0 release contains breaking changes. Please read the below information carefully before upgrading!

• Highlighted Changes
• Updating your installation to PHPCompatibility 10.0.0
  • Composer project-based install
  • Composer global install
  • Installs based on the old installation instructions
  • Other types of installs
  • Removing artifacts from old installation methods
  • CI integration
• Updating your custom ruleset and PHPCS ignore annotations
  • Removed Sniffs
  • Renamed Sniffs
  • Changed Error Codes [1]
  • Changed Error Codes [2]
• All classes are now final
• Other

• Policy change: As of this release, PHPCompatibility will no longer support a wide range of PHP_CodeSniffer versions. The minimum supported PHP_CodeSniffer version will be raised anytime syntax support for a new PHP feature is added to PHP_CodeSniffer and this syntax support is needed for the PHPCompatibility sniffs.
• Policy change: As of this release, the only supported manner of installation of PHPCompatibility will be via Composer. Installation using git clones or with the PHP_CodeSniffer PHAR files is still possible, but no support will be provided for this.
• New runtime dependencies:
  • The Composer PHPCS plugin to register the standard with PHP_CodeSniffer.
  • PHPCSUtils, a library of utility function for PHP_CodeSniffer.
• All PHPCompatibility sniffs are now final classes.
• All sniffs are now compatible with PHP_CodeSniffer 3.x as well as 4.0.

Please follow the below upgrade instructions carefully. This should be a one-time only action.

If you were already using a Composer project-based install, upgrade PHPCompatibility by running:

composer remove --dev dealerdirect/phpcodesniffer-composer-installer higidi/composer-phpcodesniffer-standards-plugin squizlabs/PHP_codesniffer
composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer require --dev phpcompatibility/php-compatibility:"^10.0.0@dev" --update-with-dependencies

If you were already using a Composer global install, upgrade PHPCompatibility by running:

composer global remove --dev dealerdirect/phpcodesniffer-composer-installer higidi/composer-phpcodesniffer-standards-plugin squizlabs/PHP_codesniffer
composer global config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer global require --dev phpcompatibility/php-compatibility:"^10.0.0@dev" --update-with-dependencies

If you were using a Composer install which was created using the composer create-project command, had downloaded the release zip directly or were using a git clone-based install, please delete the directory in which you had PHPCompatibility installed and follow the new installation instructions in the Readme to install PHPCompatibility from scratch using Composer.

If you were using a stand-alone install of PHP_CodeSniffer, like a git clone, PHAR, or PEAR install, with which you had registered PHPCompatibility using the installed_paths command, we strongly recommend you use a Composer based install instead. While installing PHPCompatibility without Composer is still possible, no support will be given anymore for such installs.

If you have a <config name="installed_paths" value="/path/to/phpcompatibility" /> directive in your [.]phpcs.xml[.dist] ruleset file, please remove it.

The Composer PHPCS plugin is now included by default and will take care of setting the installed paths for Composer based installs.

Along the same lines, if you had a Composer post-install-cmd (or similar) script which registered the installed_paths, please remove it as it will interfere/overwrite the installed paths which the Composer plugin sets.

You may need to re-run composer install after removing these artifacts.

If necessary, also update your CI scripts to use a Composer based installation.

A number of sniffs/error codes have different names in PHPCompatibility 10.0.0.

If you referred to any of these directly, either in your [.]phpcs.xml[.dist] ruleset file or in inline phpcs:ignore/disable/enable annotations, you will need to update the referenced name.

The following sniffs have been removed without (direct) replacement:

• PHPCompatibility.Keywords.ForbiddenNamesAsInvokedFunctions
• PHPCompatibility.Keywords.ForbiddenNamesAsDeclared
• PHPCompatibility.Upgrade.LowPHPCS

Any references to these sniffs, whether from within a ruleset or in ignore annotations, should be removed.

Additionally, the check for the use of hexadecimal numeric strings has been moved from the PHPCompatibility.Miscellaneous.ValidIntegers sniff to a new stand-alone PHPCompatibility.Numbers.RemovedHexadecimalNumericStrings sniff.

This changes the error code from PHPCompatibility.Miscellaneous.ValidIntegers.HexNumericStringFound to PHPCompatibility.Numbers.RemovedHexadecimalNumericStrings.Found.

A number of error codes have changed due to PHP itself changing the name of function parameters in PHP 8.0.

There have also been a few error code changes due to changes in sniff functionality.

In addition to that, the following error codes have been split:

All non-abstract classes, including the sniffs, in the PHPCompatibility package are now declared as final.

The PHP_CodeSniffer autoloader does not always play nice with sniffs which extend other sniffs, especially if both sniffs (parent and child) are included in the same standard.

To discourage sniffs extending each other, all non-abstract classes have been made final.

If needs be, a sniff in an external standard can still use logic used in the PHPCompatibility sniffs. On the one hand, the sniff can use utility methods from PHPCSUtils. On the other hand, the sniff can do a preliminary check on certain data and defer to a new or pre-instantiated instance of a PHPCompatibility sniff for everything else.

If this change causes you insurmountable problems, please open an issue in the repo to request for a class to become non-final and explain your use case. Each such issue will be evaluated on its own merits.

Please read the changelog carefully before upgrading.

This release contains lots of bugfixes, so if you'd previously ignored certain issues, either from the ruleset or using the PHPCS selective ignore annotations, because of bugs in sniffs, please review your ignore annotations using the --ignore-annotations CLI option and/or re-enable those sniffs.