Add support for a new polyfill composer package

[llaville]

Steps to add support for a new polyfill composer package

Feature introduced with version 4.2.0 (see request report #120)

1. Create database structure

This step was not changed since previous versions 4.x; you have to invoke the db:create command that will print following results if successfull

2. Add one polyfill composer package

This step is new, because it uses the new db:polyfill command. On first try you should encounter following error (raised by auto-diagnose feature)

So initialize the database contents with db:init command, that should produced following output.

On next try to run the db:polyfill command, you should get its help (as any other symfony console command) if you forget arguments and option.

IMPORTANT Don't forget to run the db:init -f command after add one or more polyfill packages to refresh the database, because db:polyfill command update only the JSON files (into data/reference/extension/** directories)

3. Use Case

Add the polyfill for PHP 8.1 features with the symfony/polyfill-php81 composer package.

Provide arguments required by db:polyfill command :

• the package name (composer name) => symfony/polyfill-php81
• the package tag (composer version) => v1.25.0 (is the latest available when this post is written)
• the PHP version support => 8.1
• optionally: active verbose mode (-v or -vvv) for more details about operation

In case of success, you should get such following ouput :

And you can checks if results applied to JSON files are correct with git diff command

diff --git a/data/reference/extension/core/81/functions.json b/data/reference/extension/core/81/functions.json
index 99fa2ce9..665c6ca0 100644
--- a/data/reference/extension/core/81/functions.json
+++ b/data/reference/extension/core/81/functions.json
@@ -2,6 +2,7 @@
     {
         "name": "enum_exists",
         "ext_min": "8.1.0alpha1",
-        "php_min": "8.1.0alpha1"
+        "php_min": "8.1.0alpha1",
+        "polyfill": "symfony/polyfill-php81"
     }
 ]
diff --git a/data/reference/extension/mysqli/81/constants.json b/data/reference/extension/mysqli/81/constants.json
index faef34d5..b4871fdf 100644
--- a/data/reference/extension/mysqli/81/constants.json
+++ b/data/reference/extension/mysqli/81/constants.json
@@ -7,7 +7,8 @@
     {
         "name": "MYSQLI_REFRESH_REPLICA",
         "ext_min": "8.1.0alpha1",
-        "php_min": "8.1.0alpha1"
+        "php_min": "8.1.0alpha1",
+        "polyfill": "symfony/polyfill-php81"
     },
     {
         "name": "MYSQLI_IS_MARIADB",
diff --git a/data/reference/extension/standard/81/functions.json b/data/reference/extension/standard/81/functions.json
index 6258b2ca..b6895009 100644
--- a/data/reference/extension/standard/81/functions.json
+++ b/data/reference/extension/standard/81/functions.json
@@ -2,7 +2,8 @@
     {
         "name": "array_is_list",
         "ext_min": "8.1.0alpha1",
-        "php_min": "8.1.0alpha1"
+        "php_min": "8.1.0alpha1",
+        "polyfill": "symfony/polyfill-php81"
     },
     {
         "name": "fsync",

If your infrastructure is not correct :

• composer or phpcompatinfo commands not available

You should encounter error like :

What does it means ?

The db:poylfill command requires PHP_Compatinfo to analyse and extract constants and functions provided by the polyfill package.

TIP I suggest to generate a PHAR version of PHP_CompatInfo, make it executable, and put it anywhere in your PATH (including vendor/bin of this project)

[llaville]

4. Debug mode

db:polyfill command has evolved to print in console verbose mode level 3 (debug) the details of constants and functions found.

See, for example, with the symfony/polyfill-iconv package.

In this example, you must set --php option to values 4.0, 4.3 and 5.0 to include all constants and functions.

Command to invoke become db:polyfill symfony/polyfill-iconv v1.25.0 --php 4.0 --php 4.3 --php 5.0 -vvv

That should print following output

[llaville]

5. Whitelist

db:polyfill command has evolved since version 4.6.0 to be able to scan all files of a composer package rather than just bootstrap.php file available in all Symfony Polyfills

Example with symfony/polyfill-php82 that should detect new classes.

By default with default whitelist, it's not possible : see following results

When you remove default whitelist, you will get something like