When you encounter an error "Your platform does not satisfy that requirement", you can use the --ignore-platform-reqs parameter to ignore the platform requirements for installation. The full name of this parameter is --ignore-platform-requirements. It is used to skip the PHP version, extension and other checks specified in composer.json when executing composer install or update. For example, if the current PHP version is 8.0 but the configuration requires 8.1, an error will be reported by default. If you add this parameter, the check will be skipped. Applicable scenarios include: 1. The local environment in containerized deployment or CI environment is inconsistent with the real operating environment; 2. Test the compatibility of old code in the new environment; 3. Temporary debugging of dependency package issues. It is recommended to use it temporarily only to avoid concealing potential problems. Use method such as: composer install --ignore-platform-reqs, and can also be combined with --platform parameter to overwrite specific values ??such as php version. Note: 1. Skip the check may cause an error or crash during the runtime of the application; 2. Ignored requirements include PHP version, extension, etc.; 3. It can be used with composer.lock, and only skip the check if the dependency structure remains unchanged. Only by correctly understanding its purpose and risks can this tool be used reasonably.

You may have encountered an error message like "Your platform does not satisfy that requirement" when using Composer for dependency management. At this time, the --ignore-platform-reqs parameter can come in handy.

It essentially tells Composer: "Don't worry whether my local environment meets these requirements or not, install it directly." This is useful in some scenarios, such as when you switch between a development environment and a production environment, or if you want to temporarily bypass some version restrictions.

What is --ignore-platform-reqs

The full name of this flag is --ignore-platform-requirements , which is used to ignore the platform requirements specified in composer.json (such as PHP version, extension, etc.) when executing composer install or composer update .

For example:
If you write "php": "8.1" in your composer.json , but you are currently running PHP 8.0, Composer will report an error by default. After adding --ignore-platform-reqs , it will not check this condition.

When should I use it

This option is not used to skip the problem casually, but has a specific purpose:

• In containerized deployment or CI environment : Your local development environment may not be completely consistent, but it is the real running environment in the Docker or CI pipeline.
• Test the behavior of old code in different environments : Sometimes you want to see if old projects can run in new environments.
• Problem to debug a package temporarily : When you just want to try a dependency quickly, you don't need to strictly match all conditions.

?? Long-term use is not recommended, otherwise potential compatibility issues may be masked.

How to use it correctly

The usage method is very simple, just add this flag after the command:

 composer install --ignore-platform-reqs

Or when updated:

 composer update --ignore-platform-reqs

If you only want to ignore some platform dependencies, you can also manually overwrite individual values ??in combination with --platform parameter, for example:

 composer install --ignore-platform-reqs --platform php=8.2

This way, only the PHP version is ignored, and other platform extensions will still be checked.

Frequently Asked Questions and Precautions

• Will it cause an application error?
  Yes, Composer just skips the check, which does not mean that your environment can really support those dependencies. If the actual running environment is not satisfied, the program may report an error or even crash.

• Which platform requirements will be ignored?
  Including but not limited to: PHP version, PHP extensions (such as ext-gd ), HHVM, virtual machine settings, etc.

• Can it be used with composer.lock ?
  Can. If you already have the composer.lock file, the dependency structure installed by this flag will not change, but the platform check is ignored.

Basically that's it. After using it a few times, you will find that it is a very convenient gadget, but don't abuse it.

The above is the detailed content of How do I use the --ignore-platform-reqs flag?. For more information, please follow other related articles on the PHP Chinese website!