Php compatibility checker joomla

Saved searches

Use saved searches to filter your results more quickly

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Collection of all the PHPCS rulesets offered by the PHPCompatibility organisation.

License

PHPCompatibility/PHPCompatibilityAll

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.md

Convenience package to install all the external PHP_CodeSniffer rulesets which the PHPCompatibility organisation maintains, in one go using Composer.

What’s included in this package ?

Framework/CMS specific rulesets

Polyfill provider specific rulesets

Use the latest stable release of PHP_CodeSniffer for the best results. The minimum recommended version of PHP_CodeSniffer is version 2.6.0.

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-all:"*"

If you already have a Composer PHP_CodeSniffer plugin installed, run:

composer require --dev phpcompatibility/phpcompatibility-all:"*"

If all went well, you will now see that the PHPCompatibility , PHPCompatibilityJoomla , PHPCompatibilityWP and a number of polyfill related standards are installed for PHP_CodeSniffer.

Now you can use any of the following commands to inspect your code:

./vendor/bin/phpcs -p . --standard=PHPCompatibility ./vendor/bin/phpcs -p . --standard=PHPCompatibilityJoomla ./vendor/bin/phpcs -p . --standard=PHPCompatibilityWP ./vendor/bin/phpcs -p . --standard=PHPCompatibilityPasswordCompat ./vendor/bin/phpcs -p . --standard=PHPCompatibilityParagonieRandomCompat ./vendor/bin/phpcs -p . --standard=PHPCompatibilityParagonieSodiumCompat ./vendor/bin/phpcs -p . --standard=PHPCompatibilitySymfonyPolyfillPHP54 ./vendor/bin/phpcs -p . --standard=PHPCompatibilitySymfonyPolyfillPHP73 . etc. # You can also combine the standards if your project uses several: ./vendor/bin/phpcs -p . --standard=PHPCompatibilityPasswordCompat,PHPCompatibilitySymfonyPolyfillPHP70,PHPCompatibilityWP

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

To get the most out of the PHPCompatibility standards, 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.

• You can run the checks for just one specific PHP version by adding —runtime-set testVersion 5.5 to your command line command.
• You can also specify a range of PHP versions that your code needs to support. In this situation, compatibility issues that affect any of the PHP versions in that range will be reported: —runtime-set testVersion 5.3-5.5 .
• Since PHPCompatibility 7.1.3, you can omit one part of the range if you want to support everything above or below a particular version, i.e. use —runtime-set testVersion 7.0- to run all the checks for PHP 7.0 and above.

# For a Joomla project which should be compatible with PHP 5.3 up to and including PHP 7.0: ./vendor/bin/phpcs -p . --standard=PHPCompatibilityJoomla --runtime-set testVersion 5.3-7.0 # For a project using both the Paragonie Sodium Compat polyfill as well as the Symfony PHP 7.1 polyfill and which should be compatible with PHP 5.4 and higher: ./vendor/bin/phpcs -p . --standard=PHPCompatibilityParagonieSodiumCompat,PHPCompatibilitySymfonyPolyfillPHP71 --runtime-set testVersion 5.4-

For more detailed information, see the README of the main 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=PHPCompatibilitySymfonyPolyfillPHP56 --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

• README: Updated the installation instructions for compatibility with Composer >= 2.2.
• Composer: The package will now identify itself as a static analysis tool. Thanks @GaryJones!
• Other housekeeping and minor documentation updates.

• 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.

• The recommended version of the Composer PHPCS plugin is now ^0.5.0 .
• 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.

• Added the new PHPCompatibilityPasswordCompat, PHPCompatibilityParagonie, PHPCompatibilitySymfony rulesets.

Initial release containing the PHPCompatibility, PHPCompatibilityJoomla and PHPCompatibilityWP rulesets.

About

Collection of all the PHPCS rulesets offered by the PHPCompatibility organisation.

Источник

PHPCompatibilityJoomla

Using PHPCompatibilityJoomla, you can analyse the codebase of a Joomla-based project for PHP cross-version compatibility.

What’s in this repo ?

A ruleset for PHP_CodeSniffer to check for PHP cross-version compatibility issues in projects based on the Joomla CMS.

This Joomla specific ruleset prevents false positives from the PHPCompatibility standard by excluding back-fills and poly-fills which are provided by Joomla.

Requirements

Use the latest stable release of PHP_CodeSniffer for the best results. The minimum recommended version of PHP_CodeSniffer is version 2.6.0.

Installation instructions

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-joomla:"*"

If you already have a Composer PHP_CodeSniffer plugin installed, run:

composer require --dev phpcompatibility/phpcompatibility-joomla:"*"

If all went well, you will now see that the PHPCompatibility , PHPCompatibilityJoomla and several other PHPCompatibility standards are installed for PHP_CodeSniffer.

How to use

Now you can use the following command to inspect your code:

./vendor/bin/phpcs -p . --standard=PHPCompatibilityJoomla

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

To get the most out of the PHPCompatibilityJoomla standard, 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.

The minimum PHP requirement of the Joomla project at this time is PHP 5.3.10. If you want to enforce this, either add —runtime-set testVersion 5.3- to your command-line command or add to your custom ruleset.

# For a project which should be compatible with PHP 5.3 and higher: ./vendor/bin/phpcs -p . --standard=PHPCompatibilityJoomla --runtime-set testVersion 5.3-

For more detailed information about setting the testVersion , see the README of the generic PHPCompatibility standard.

Testing PHP files only

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=PHPCompatibilityJoomla --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, visit https://www.gnu.org/copyleft/lesser.html

Changelog

2.1.3 — 2022-10-25

• README: Updated the installation instructions for compatibility with Composer >= 2.2.
• Composer: The package will now identify itself as a static analysis tool. Thanks @GaryJones!
• Other housekeeping and minor documentation updates.

2.1.2 — 2021-02-15

• The recommended version of the Composer PHPCS plugin is now ^0.7.0 , which offers compatibility with Composer 2.0.
• The ruleset is 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.

2.1.1 — 2019-08-29

2.1.0 — 2018-12-16

• Ruleset: Updated for the PHP 7.1 polyfill which is included in Joomla 3.9.
• The ruleset is 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.

2.0.0 — 2018-10-07

• Ruleset: Updated for Joomla 3.9.
• Ruleset: Updated for compatibility with PHPCompatibility 9.0+.
• Composer: Added dependencies for the dedicated polyfill-based PHPCompatibility rulesets.
• CI: Added a test for the ruleset.
• Readme: Removed the installation instructions for a non-Composer based install.

1.0.0 — 2018-07-17

Initial release of the PHPCompatibilityJoomla ruleset.

Источник