Using PHPCompatibilityParagonie, you can analyse the codebase of a project using either of the Paragonie polyfills, for PHP cross-version compatibility.
What's in this repo ?
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|
Note: As the
random_compatas a dependency, the
PHPCompatibilityParagonieSodiumCompatruleset includes the
In practice, this means that if your project uses both libraries, you just need to use the
PHPCompatibilityParagonieSodiumCompatruleset to prevent false positives from both.
Use the latest stable release of PHP_CodeSniffer for the best results. The minimum recommended version of PHP_CodeSniffer is version 2.6.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 require --dev dealerdirect/phpcodesniffer-composer-installer:^0.4.4 phpcompatibility/phpcompatibility-paragonie:* composer install
If you already have a Composer PHP_CodeSniffer plugin installed, run:
composer require --dev phpcompatibility/phpcompatibility-paragonie:* composer install
If all went well, you will now see that the
PHPCompatibilityParagonieSodiumCompat standards are installed for PHP_CodeSniffer.
How to use
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 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.
Testing PHP files only
./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
1.0.1 - 2018-12-16
- Prevent false positives when the ruleset is run over the code of the
- 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.
1.0.0 - 2018-10-07
Initial release of PHPCompatibilityParagonie containing rulesets covering the
sodium_compat polyfill libraries.