Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

PHPCompatibility rulesets which can be included in projects using the Symfony polyfill libraries

License

NotificationsYou must be signed in to change notification settings

PHPCompatibility/PHPCompatibilitySymfony

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Latest Stable VersionLatest Unstable VersionLicenseBuild Status

Using PHPCompatibilitySymfony, you can analyse the codebase of a project using any of theSymfony polyfill libraries, for PHP cross-version compatibility.

What's in this repo ?

A set of rulesets for PHP_CodeSniffer to check for PHP cross-version compatibility issues in projects, while accounting for polyfills provided by the Symfony polyfill libraries.

These rulesets prevent false positives from thePHPCompatibility standard by excluding back-fills and polyfills which are provided by those libraries.

Symfony Polyfill LibraryCorresponding PHPCompatibility RulesetIncludes
polyfill-php54PHPCompatibilitySymfonyPolyfillPHP54
polyfill-php55PHPCompatibilitySymfonyPolyfillPHP55PHPCompatibilityPasswordCompat
polyfill-php56PHPCompatibilitySymfonyPolyfillPHP56
polyfill-php70PHPCompatibilitySymfonyPolyfillPHP70PHPCompatibilityParagonieRandomCompat
polyfill-php71PHPCompatibilitySymfonyPolyfillPHP71
polyfill-php72PHPCompatibilitySymfonyPolyfillPHP72
polyfill-php73PHPCompatibilitySymfonyPolyfillPHP73
polyfill-php74PHPCompatibilitySymfonyPolyfillPHP74
polyfill-php80PHPCompatibilitySymfonyPolyfillPHP80
polyfill-php81PHPCompatibilitySymfonyPolyfillPHP81
polyfill-php82PHPCompatibilitySymfonyPolyfillPHP82
polyfill-php83PHPCompatibilitySymfonyPolyfillPHP83
polyfill-php84PHPCompatibilitySymfonyPolyfillPHP84
polyfill-php85PHPCompatibilitySymfonyPolyfillPHP85

Note

About "Includes":
Some polyfills have other polyfills as dependencies. If the PHPCompatibility project offers a dedicated ruleset for the polyfill dependency, that ruleset will be included in the ruleset for the higher level polyfill.

For example:
As thepolyfill-php70 library declaresrandom_compatas a dependency, thePHPCompatibilitySymfonyPolyfillPHP70 ruleset includes thePHPCompatibilityParagonieRandomCompat ruleset.

In practice, this means that if your project uses several polyfills, you can use the information in "Includes" to help you decide which rulesets to use.

Funding

This project needs funding.

The project team has spend thousands of hours creating and maintaining the PHPCompatibility packages. This is unsustainable without funding.

If you use PHPCompatibility, please fund this work by setting up a monthly contribution to thePHP_CodeSniffer Open Collective.

Requirements

Installation instructions

The only supported installation method is viaComposer.

Composer will automatically install the project dependencies and register the external rulesets with PHP_CodeSniffer using theComposer PHPCS plugin.

Run the following from the root of your project:

composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installertruecomposer require --dev phpcompatibility/phpcompatibility-symfony:"^2.0@dev"

Next, run:

vendor/bin/phpcs -i

If all went well, you will now see that the PHPCompatibility and a range of PHPCompatibilitySymfony and other PHPCompatibility standards are installed for PHP_CodeSniffer.

Upgrade instructions

To upgrade this package, run the following command:

composer update --dev phpcompatibility/phpcompatibility-symfony --with-dependencies

Tip

If you have aroot requirement in your project for one of the packages used by this project, you may need to update with--with-all-dependencies instead.

How to use

You can now use the following commands to inspect the code in your project for PHP cross-version compatibility:

vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP54vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP55vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP56vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP70vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP71vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP72vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP73vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP74vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP80vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP81vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP82vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP83vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP84vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP85# You can also combine the standards if your project uses several:vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP55,PHPCompatibilitySymfonyPolyfillPHP70,PHPCompatibilitySymfonyPolyfillPHP73

By default, you will only receive notifications about deprecated and/or removed PHP features.

To get the most out of the PHPCompatibilitySymfony rulesets, you should specify atestVersion 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=PHPCompatibilitySymfonyPolyfillPHP56 --runtime-set testVersion 5.3-7.0# For a project which should be compatible with PHP 7.2 and higher:vendor/bin/phpcs -p. --standard=PHPCompatibilitySymfonyPolyfillPHP73 --runtime-set testVersion 7.2-

For more detailed information about setting thetestVersion, see the README of the genericPHPCompatibility(PHPCompatibility-testVersion standard.

Testing PHP files only

By default PHP_CodeSniffer < 4.0 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=PHPCompatibilitySymfonyPolyfillPHP71 --extensions=php --runtime-set testVersion 5.3-

License

All code within the PHPCompatibility organisation is released under the GNU Lesser General Public License (LGPL). For more information, visithttps://www.gnu.org/licenses/lgpl-3.0.html.

About

PHPCompatibility rulesets which can be included in projects using the Symfony polyfill libraries

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors5

Languages

[8]ページ先頭
©2009-2025 Movatter.jp