Using PHPCompatibilityParagonie, you can analyse the codebase of a project using either of the Paragonie polyfills, for PHP cross-version compatibility.
Two rulesets for PHP_CodeSniffer to check for PHP cross-version compatibility issues in projects, while accounting for polyfills provided by the Paragonie polyfill libraries.
These rulesets prevent false positives from the PHPCompatibility standard by excluding back-fills and poly-fills which are provided by those libraries.
Paragonie Polyfill Library | Corresponding PHPCompatibility Ruleset | Includes |
---|---|---|
random_compat |
PHPCompatibilityParagonieRandomCompat |
|
sodium_compat |
PHPCompatibilityParagonieSodiumCompat |
PHPCompatibilityParagonieRandomCompat |
Note: As the
sodium_compat
library hasrandom_compat
as a dependency, thePHPCompatibilityParagonieSodiumCompat
ruleset includes thePHPCompatibilityParagonieRandomCompat
ruleset.In practice, this means that if your project uses both libraries, you just need to use the
PHPCompatibilityParagonieSodiumCompat
ruleset to prevent false positives from both.
-
- PHP 5.3+ for use with PHP_CodeSniffer 2.3.0+.
- PHP 5.4+ for use with PHP_CodeSniffer 3.0.2+.
Use the latest stable release of PHP_CodeSniffer for the best results. The minimum recommended version of PHP_CodeSniffer is version 2.6.0.
-
PHPCompatibility 9.0.0+.
The only supported installation method is via Composer.
If you don't have a Composer plugin installed to manage the installed_paths
setting for PHP_CodeSniffer, run the following from the command-line:
composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer require --dev dealerdirect/phpcodesniffer-composer-installer:"^0.7" phpcompatibility/phpcompatibility-paragonie:"*"
If you already have a Composer PHP_CodeSniffer plugin installed, run:
composer require --dev phpcompatibility/phpcompatibility-paragonie:"*"
Next, run:
vendor/bin/phpcs -i
If all went well, you will now see that the PHPCompatibility
, PHPCompatibilityParagonieRandomCompat
and PHPCompatibilityParagonieSodiumCompat
standards are installed for PHP_CodeSniffer.
Now you can use the following commands to inspect the code in your project for PHP cross-version compatibility:
./vendor/bin/phpcs -p . --standard=PHPCompatibilityParagonieRandomCompat
./vendor/bin/phpcs -p . --standard=PHPCompatibilityParagonieSodiumCompat
By default, you will only receive notifications about deprecated and/or removed PHP features.
To get the most out of the PHPCompatibilityParagonie rulesets, you should specify a testVersion
to check against. That will enable the checks for both deprecated/removed PHP features as well as the detection of code using new PHP features.
For example:
# For a project which should be compatible with PHP 5.3 up to and including PHP 7.0:
./vendor/bin/phpcs -p . --standard=PHPCompatibilityParagonieRandomCompat --runtime-set testVersion 5.3-7.0
# For a project which should be compatible with PHP 5.4 and higher:
./vendor/bin/phpcs -p . --standard=PHPCompatibilityParagonieSodiumCompat --runtime-set testVersion 5.4-
For more detailed information about setting the testVersion
, see the README of the generic PHPCompatibility standard.
By default PHP_CodeSniffer will analyse PHP, JavaScript and CSS files. As the PHPCompatibility sniffs only target PHP code, you can make the run slightly faster by telling PHP_CodeSniffer to only check PHP files, like so:
./vendor/bin/phpcs -p . --standard=PHPCompatibilityParagonieRandomCompat --extensions=php --runtime-set testVersion 5.3-
All code within the PHPCompatibility organisation is released under the GNU Lesser General Public License (LGPL). For more information, visit https://www.gnu.org/copyleft/lesser.html
- The recommended version of the Composer PHPCS plugin is now
^0.7.0
, which offers compatibility with Composer 2.0. - The rulesets are now also tested against PHP 7.4 and 8.0. Note: full PHP 7.4 support is only available in combination with PHP_CodeSniffer 3.5.6. Note: runtime PHP 8.0 support is only available in combination with PHP_CodeSniffer 3.5.7, full support is expected in PHP_CodeSniffer 3.6.0.
- Ruleset update for full compatibility with version
1.12.0
ofsodium_compat
.
- Ruleset update for full compatibility with version
1.11.0
ofsodium_compat
.
- The
PHPCompatibilityParagonieSodiumCompat
ruleset has been updated to account for the latest changes in thesodium_compat
polyfill. - Prevent false positives when the ruleset is run over the code of the
sodium_compat
polyfill itself. - Composer: The recommended version of the Composer PHPCS plugin has been upped to
^0.5.0
. - CI: Improved integration test for the
SodiumCompat
ruleset. - CI: Added early warning system for false positives due to changes in the polyfill libraries themselves.
- Prevent false positives when the ruleset is run over the code of the
random_compat
polyfill itself. - The rulesets are now also tested against PHP 7.3. Note: full PHP 7.3 support is only available in combination with PHP_CodeSniffer 2.9.2 or 3.3.1+ due to an incompatibility within PHP_CodeSniffer itself.
Initial release of PHPCompatibilityParagonie containing rulesets covering the random_compat
and sodium_compat
polyfill libraries.